{
"x-generator": "NSwag v14.6.3.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))",
"openapi": "3.0.0",
"info": {
"title": "MaidCentral Pulse Connect API",
"description": "Pulse Connect is MaidCentral's API for connecting approved software, command-line tools, MCP servers and AI assistants to a branch's Pulse data.\n\nBase URL: `https://api.maidcentral.ai/api/connect/v1` (production). External pilot partners use staging only: `https://api.staging.maidcentral.ai/api/connect/v1`. Send your API key in the `X-API-Key` header on every request.\n\nGuides (quickstart, scopes, writes, errors, webhooks): https://docs.maidcentral.ai/docs/pulse-connect/\n\nThe payloads Pulse sends to your webhook URL are listed under **Webhook events**.",
"version": "1.0.0-pilot"
},
"servers": [
{
"url": "https://api.staging.maidcentral.ai/api/connect/v1",
"description": "Staging (external pilot partners)"
},
{
"url": "https://api.maidcentral.ai/api/connect/v1",
"description": "Production"
}
],
"paths": {
"/webhook-events": {
"get": {
"tags": [
"Webhooks"
],
"summary": "List the events this credential can subscribe to",
"description": "Only the events this key holds the scope to subscribe to.",
"operationId": "connectListWebhookEvents",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWebhookEventCatalogResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"webhooks.manage"
],
"x-connect-capability": "feature.connectApi.webhooks",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "webhook-admin",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": false
}
},
"/webhooks": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Create a subscription and return its secret once",
"description": "The signing secret is returned once, in this response; store it. A branch at its subscription limit answers 409 webhook_subscription_limit_reached.",
"operationId": "connectCreateWebhook",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectWebhookCreateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWebhookCreateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWebhookCreatedResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "webhook_subscription_limit_reached (detail names the branch's limit; delete one first), idempotency_conflict, or context_not_configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"webhooks.manage"
],
"x-connect-capability": "feature.connectApi.webhooks",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "webhook-admin",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": true
},
"get": {
"tags": [
"Webhooks"
],
"summary": "List branch subscriptions",
"description": "The branch's subscriptions with their status, events and pause reason. The secret is never returned.",
"operationId": "connectListWebhooks",
"parameters": [
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWebhookPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"webhooks.manage"
],
"x-connect-capability": "feature.connectApi.webhooks",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "webhook-admin",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": false
}
},
"/webhooks/{webhook_id}": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Get one subscription",
"description": "A deleted subscription answers 404 here.",
"operationId": "connectGetWebhook",
"parameters": [
{
"name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWebhookResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"webhooks.manage"
],
"x-connect-capability": "feature.connectApi.webhooks",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "webhook-admin",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": false
},
"patch": {
"tags": [
"Webhooks"
],
"summary": "Change a subscription's URL, description, events, or pause state",
"description": "Send only what changes. Resuming a paused subscription delivers the events held while it was paused.",
"operationId": "connectUpdateWebhook",
"parameters": [
{
"name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "whsub_9f1c2b8a4d6e4f0b8c1a2d3e4f5a6b7c"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectWebhookUpdateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWebhookUpdateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWebhookResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"webhooks.manage"
],
"x-connect-capability": "feature.connectApi.webhooks",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "webhook-admin",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": true
},
"delete": {
"tags": [
"Webhooks"
],
"summary": "Delete a subscription; repeating it stays safe",
"description": "Repeating the delete is safe. The subscription's delivery history stays readable at /deliveries.",
"operationId": "connectDeleteWebhook",
"parameters": [
{
"name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"webhooks.manage"
],
"x-connect-capability": "feature.connectApi.webhooks",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "webhook-admin",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": false
}
},
"/webhooks/{webhook_id}/rotate-secret": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Issue a replacement secret with a 24-hour signature overlap",
"description": "Returns the new secret once. For 24 hours each delivery carries signatures from both secrets, so you can switch over without missing one.",
"operationId": "connectRotateWebhookSecret",
"parameters": [
{
"name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWebhookCreatedResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"webhooks.manage"
],
"x-connect-capability": "feature.connectApi.webhooks",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "webhook-admin",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": true
}
},
"/webhooks/{webhook_id}/test": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Queue a synthetic connect.test event for this subscription",
"description": "Delivered and signed like a real event, with resource.type \"webhook\" and an empty data object.",
"operationId": "connectSendWebhookTest",
"parameters": [
{
"name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWebhookDeliveryResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"webhooks.manage"
],
"x-connect-capability": "feature.connectApi.webhooks",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "webhook-admin",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": false
}
},
"/webhooks/{webhook_id}/deliveries": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Read 30 days of redacted delivery metadata",
"description": "Each attempt's state, response status and failure category for the last 30 days. Payload bodies are not returned.",
"operationId": "connectListWebhookDeliveries",
"parameters": [
{
"name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWebhookDeliveryPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"webhooks.manage"
],
"x-connect-capability": "feature.connectApi.webhooks",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "webhook-admin",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": false
}
},
"/usage": {
"get": {
"tags": [
"Usage"
],
"summary": "Get current monthly API usage for the branch",
"description": "The current UTC month's allowance, operations used and remaining, the reset time and a breakdown. Free: no usage is counted.",
"operationId": "connectGetUsage",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectUsageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"usage.read"
],
"x-connect-capability": "feature.connectApi",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "context",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": false
}
},
"/time-summaries/daily": {
"get": {
"tags": [
"Time"
],
"summary": "List worked-time totals per technician per day",
"description": "One row per technician per work date, from the day clock. work_date is the branch's clock day the technician clocked in on; a shift that runs past midnight belongs wholly to the day it started. For a branch whose zone is set to UTC the clock day is US Eastern, as on availability and billing, although GET /branches reports it as Etc/UTC. worked_minutes is the sum of the day's closed clock entries in whole minutes, computed from the stored UTC instants, so a daylight-saving change never adds or removes an hour; an entry whose end is not after its start counts 0. Unpaid breaks are already excluded, because an unpaid break clocks the technician out and back in; paid breaks count as worked time. An entry still open counts 0 and sets has_open_entry, so 0 with has_open_entry true is an open shift, not an empty day. A day with no clock entries has no row. start_date and end_date are both required and inclusive, at most 31 days; anything else is invalid_request. technician_id is an id from GET /technicians; one this branch does not own answers an empty page.",
"operationId": "connectListDailyTimeSummaries",
"parameters": [
{
"name": "start_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "end_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "technician_id",
"in": "query",
"description": "A technician id as listed by GET /technicians.",
"schema": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"nullable": true
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectDailyTimeSummaryPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"time.read"
],
"x-connect-capability": "feature.connectApi.timeTracking",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "employee-operational",
"x-connect-requires-idempotency": false
}
},
"/time-summaries/jobs": {
"get": {
"tags": [
"Time"
],
"summary": "List worked-time totals per job, with a per-technician breakdown",
"description": "One row per job, from the job timesheets, with each technician's total in technicians. work_date is the job's job_date, as GET /jobs publishes it. worked_minutes is the sum of the closed timesheet entries in whole minutes, computed from the stored UTC instants, so a daylight-saving change never adds or removes an hour; an entry whose end is not after its start counts 0. Job totals never deduct breaks, paid or unpaid. An entry still open counts 0 and sets has_open_entry on the technician and on the job. A job with no timesheet entries has no row. start_date and end_date are both required and inclusive, at most 31 days; anything else is invalid_request. technician_id is an id from GET /technicians and narrows each job's totals to that technician; one this branch does not own answers an empty page.",
"operationId": "connectListJobTimeSummaries",
"parameters": [
{
"name": "start_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "end_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "technician_id",
"in": "query",
"description": "A technician id as listed by GET /technicians.",
"schema": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"nullable": true
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobTimeSummaryPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"time.read"
],
"x-connect-capability": "feature.connectApi.timeTracking",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "employee-operational",
"x-connect-requires-idempotency": false
}
},
"/service-sets/{service_set_id}/cancel": {
"post": {
"tags": [
"Service sets"
],
"summary": "Cancel a recurring service from a date",
"description": "The first scheduled visit on or after effective_date is cancelled and every later scheduled visit is removed, as the office Cancel Service does; earlier visits are untouched. No fee, payment, refund or customer email. version is the service set's updated_at; a service set changed since is refused with version_conflict. service_not_eligible when no scheduled visit remains on or after the date or that visit has technician time.",
"operationId": "connectCancelServiceSet",
"parameters": [
{
"name": "service_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "3187"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectServiceSetCancelRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectServiceSetCancelRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectServiceSetResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "version_conflict, service_not_eligible (no scheduled visit on or after effective_date, or it has technician time), idempotency_conflict, or context_not_configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"services.cancel"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": true
}
},
"/service-sets/cancel-reasons": {
"get": {
"tags": [
"Service sets"
],
"summary": "List the Cancel Service reasons",
"description": "The reason_id values POST /service-sets/{service_set_id}/cancel accepts: the branch's active Cancel Service reasons, by name. Free: no usage is counted.",
"operationId": "connectListServiceCancelReasons",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectTicketReasonsResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"services.cancel"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "free",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/service-sets": {
"get": {
"tags": [
"Service sets"
],
"summary": "List the branch's service sets",
"description": "Recurring and one-time services with their type, frequency, status and current per-visit price. A service set is active when it has future pending jobs.",
"operationId": "connectListServiceSets",
"parameters": [
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "customer_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "home_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "status",
"in": "query",
"description": "active or inactive.",
"schema": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
{
"name": "frequency",
"in": "query",
"description": "weekly, every_two_weeks, every_three_weeks, every_four_weeks, other_recurring, quarterly, yearly, one_time or unknown.",
"schema": {
"type": "string",
"enum": [
"weekly",
"every_two_weeks",
"every_three_weeks",
"every_four_weeks",
"other_recurring",
"quarterly",
"yearly",
"one_time",
"unknown"
]
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows whose published fields changed on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectServiceSetPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"services.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/service-sets/{service_set_id}": {
"get": {
"tags": [
"Service sets"
],
"summary": "Get one service set",
"description": "current_price is the per-visit price. Internal instructions and notes are never included.",
"operationId": "connectGetServiceSet",
"parameters": [
{
"name": "service_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectServiceSetResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"services.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/customers/{customer_id}/service-sets": {
"get": {
"tags": [
"Service sets"
],
"summary": "List one customer's service sets",
"description": "Needs customers.read and services.read. The same filters as GET /service-sets, narrowed to one customer.",
"operationId": "connectListCustomerServiceSets",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "home_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "status",
"in": "query",
"description": "active or inactive.",
"schema": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
{
"name": "frequency",
"in": "query",
"description": "weekly, every_two_weeks, every_three_weeks, every_four_weeks, other_recurring, quarterly, yearly, one_time or unknown.",
"schema": {
"type": "string",
"enum": [
"weekly",
"every_two_weeks",
"every_three_weeks",
"every_four_weeks",
"other_recurring",
"quarterly",
"yearly",
"one_time",
"unknown"
]
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows whose published fields changed on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectServiceSetPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.read",
"services.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/scorecards": {
"get": {
"tags": [
"Scorecards"
],
"summary": "List customer ratings of completed visits",
"description": "One row per rating a customer submitted. rating is 1 (worst) to 5 (best). submitted_at is the UTC minute the rating was submitted; start_date and end_date are both required and inclusive, at most 31 days, and are the branch's days from GET /branches. A rating the office excluded from scoring is not listed. A customer who re-rates a visit in V2 moves that row to the new time. Comments are not published. Anything else is invalid_request.",
"operationId": "connectListScorecards",
"parameters": [
{
"name": "start_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "end_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectScorecardPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"scorecards.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/leads": {
"post": {
"tags": [
"Sales"
],
"summary": "Capture a prospect with contact details, home statistics and first-touch attribution",
"description": "Saved the way Pulse saves a lead from its own forms, and sends the lead.created webhook. attribution is stored once, as first-touch attribution.",
"operationId": "connectCreateLead",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectLeadCreateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadCreateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"leads.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
},
"get": {
"tags": [
"Sales"
],
"summary": "List prospects who have not become customers yet",
"description": "Cursor-paged. created_date_from and created_date_to are branch-local dates, inclusive, at most 366 days apart. updated_since is a branch-local date: rows whose updated_at changed on or after that day.",
"operationId": "connectListLeads",
"parameters": [
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "created_date_from",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "created_date_to",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows whose published fields changed on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"leads.read"
],
"x-connect-capability": "feature.connectApi.sales",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/leads/{lead_id}": {
"patch": {
"tags": [
"Sales"
],
"summary": "Change a prospect's name, contact details or home statistics",
"description": "Send expected_updated_at from your last read. Only the fields you send change; attribution is refused, and an update sends no webhook.",
"operationId": "connectUpdateLead",
"parameters": [
{
"name": "lead_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "5531"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectLeadUpdateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadUpdateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"leads.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
},
"get": {
"tags": [
"Sales"
],
"summary": "Get one branch-owned prospect",
"description": "A prospect who has become a customer is no longer a lead: this read answers 404 and the record is available as a quote.",
"operationId": "connectGetLead",
"parameters": [
{
"name": "lead_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"leads.read"
],
"x-connect-capability": "feature.connectApi.sales",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/leads/{lead_id}/close": {
"post": {
"tags": [
"Sales"
],
"summary": "Close a prospect as lost with a reason; closing a closed lead changes nothing",
"description": "Send expected_updated_at from your last read. The reason and notes are saved as one note, the lead leaves the sales pipeline and its unsent drip-campaign messages are cancelled. A booked lead answers 409 lead_booked.",
"operationId": "connectCloseLead",
"parameters": [
{
"name": "lead_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "5531"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectLeadCloseRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadCloseRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "version_conflict, lead_booked (the lead has been booked), idempotency_conflict, or context_not_configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"leads.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
}
},
"/quotes/{quote_id}/book": {
"post": {
"tags": [
"Sales"
],
"summary": "Book a saved quote: confirm the first visit and create the recurring service at the saved price",
"description": "The slot is checked again when the booking is written; one no longer offered answers 409 slot_unavailable and books nothing. Nothing is charged, and the booking sends lead.converted.",
"operationId": "connectBookQuote",
"parameters": [
{
"name": "quote_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "5532"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectQuoteBookRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteBookRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteBookingResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "version_conflict (the quote was revised), quote_converted (already booked), quote_not_priced, quote_expired or quote_not_bookable (recalculate and save a revision), slot_unavailable (pick another slot), idempotency_conflict, or context_not_configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"bookings.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
}
},
"/quotes/{quote_id}/payment-links": {
"post": {
"tags": [
"Sales"
],
"summary": "Mint a hosted save-card link for a quote's prospect or booked customer",
"description": "A single-use page where the customer saves a card on file. Nothing is charged, and Pulse sends no message: deliver the url yourself and treat it as a secret.",
"operationId": "connectCreateQuotePaymentLink",
"parameters": [
{
"name": "quote_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "5532"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectQuotePaymentLinkCreateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuotePaymentLinkCreateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuotePaymentLinkResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "payments_not_configured (the branch has no payment provider, or it is not turned on for the branch), idempotency_conflict, or context_not_configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"payments.write"
],
"x-connect-capability": "feature.connectApi.payments",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-financial",
"x-connect-requires-idempotency": true
}
},
"/quotes": {
"post": {
"tags": [
"Sales"
],
"summary": "Save a priced quote for a prospect with first-touch attribution",
"description": "Saves the lead fields and a priced quote; every amount is calculated by the server. Sends lead.created once.",
"operationId": "connectCreateQuote",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectQuoteCreateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteCreateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"quotes.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
},
"get": {
"tags": [
"Sales"
],
"summary": "List the branch's quotes",
"description": "Every quote, including those whose prospect has become a customer. The same date filters as GET /leads, plus customer_id. updated_since is a branch-local date: rows whose updated_at changed on or after that day.",
"operationId": "connectListQuotes",
"parameters": [
{
"name": "customer_id",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "created_date_from",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "created_date_to",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows whose published fields changed on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuotePageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"quotes.read"
],
"x-connect-capability": "feature.connectApi.sales",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/quotes/{quote_id}": {
"patch": {
"tags": [
"Sales"
],
"summary": "Revise a saved quote's pricing selections",
"description": "Replaces every pricing selection and recalculates at the current configuration, which moves expires_at, then sends quote.revised. A quote whose prospect became a customer answers 409 quote_converted.",
"operationId": "connectUpdateQuote",
"parameters": [
{
"name": "quote_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "5532"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectQuoteUpdateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteUpdateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "version_conflict, quote_converted (the prospect has become a customer), idempotency_conflict, or context_not_configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"quotes.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
},
"get": {
"tags": [
"Sales"
],
"summary": "Get one branch-owned quote",
"description": "pricing lists the saved selections and the server-calculated per-visit price; expires_at is when that saved price stops being honoured.",
"operationId": "connectGetQuote",
"parameters": [
{
"name": "quote_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"quotes.read"
],
"x-connect-capability": "feature.connectApi.sales",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/reports/operations-kpis": {
"get": {
"tags": [
"Reports"
],
"summary": "Operations KPIs for the branch's recent payroll weeks",
"description": "The product's Core KPI calculations, published as Operations KPIs: avg-bill-per-cleaning, avg-quotes-per-week, avg-close-rate, cleanings-per-home, revenue-per-tech, rate-increase, customer-attrition, skipped-cleanings, absentee-rate, tech-turnover, techs-hired, recurring-homes, fte-techs. They are computed over the newest `weeks` payroll weeks that start on or before `as_of_date` (default: today in the branch's time zone). A branch with no payroll weeks answers 200 with data_available false and an empty metrics list, never zeros. Payroll-cost KPIs are not published.",
"operationId": "connectGetOperationsKpisReport",
"parameters": [
{
"name": "as_of_date",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "weeks",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 26,
"maximum": 104.0,
"minimum": 1.0
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectOperationsKpisReportResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"reports.read"
],
"x-connect-capability": "feature.connectApi.reports",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "report",
"x-connect-usage-class": "report_run",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/reports/week-in-review": {
"get": {
"tags": [
"Reports"
],
"summary": "Week in Review for the branch's newest completed payroll week",
"description": "The week is the branch's newest completed payroll week that starts on or before `as_of_date` (default: today in the branch's time zone). Each KPI's `average` is the mean over the `weeks_compared` weeks, including the selected one; when only one week exists the average is 0 and the trend is neutral. A branch with no completed weeks answers 200 with data_available false. Payroll-to-revenue, hourly pay rate and the sales leaderboard are not published.",
"operationId": "connectGetWeekInReviewReport",
"parameters": [
{
"name": "as_of_date",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "weeks",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 52,
"maximum": 104.0,
"minimum": 1.0
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWeekInReviewReportResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"reports.read"
],
"x-connect-capability": "feature.connectApi.reports",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "report",
"x-connect-usage-class": "report_run",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/reports/sales-kpis": {
"get": {
"tags": [
"Reports"
],
"summary": "Sales KPIs for the branch over a date range",
"description": "date_from and date_to are required and inclusive, and may span at most 366 days. With date_basis=lead_created (the default) the report follows the leads created in the range forward to `as_of_date` (default: now), which must not be before date_to; with date_basis=event it counts every event dated inside the range, and `as_of_date` is not accepted. Day boundaries match the office Sales KPIs report.",
"operationId": "connectGetSalesKpisReport",
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "date_to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "date_basis",
"in": "query",
"schema": {
"type": "string",
"default": "lead_created",
"pattern": "^(lead_created|event)$"
}
},
{
"name": "as_of_date",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectSalesKpisReportResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"reports.read"
],
"x-connect-capability": "feature.connectApi.reports",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "report",
"x-connect-usage-class": "report_run",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/reports/schedule-efficiency": {
"get": {
"tags": [
"Reports"
],
"summary": "Schedule Efficiency for one branch scheduling day",
"description": "`date` is required and is a calendar day in the branch's scheduling zone (Eastern for a branch whose zone is set to UTC); `team_ids` narrows the teams. Each team's hours, revenue, miles and drive minutes come from the office Schedule Efficiency report, which reads recorded routes. `routing_evidence` says what the distances stand on: recorded (a current route), stale (the schedule changed since the route was recorded, or an optimized route is still owed), missing (stops to route but no recorded route) or not_routed (nothing to route that day). Distances on a team that is not recorded are published as stored, usually 0, so read the evidence before treating 0 as a measurement. Optimized values are null when no optimized route is recorded. A read never computes or refreshes a route. Stops, addresses, coordinates and crew members are not published.",
"operationId": "connectGetScheduleEfficiencyReport",
"parameters": [
{
"name": "date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "team_ids",
"in": "query",
"description": "Comma-separated team ids, at most 50.",
"schema": {
"type": "string",
"pattern": "^[1-9][0-9]*(,[1-9][0-9]*){0,49}$",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectScheduleEfficiencyReportResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"reports.read"
],
"x-connect-capability": "feature.connectApi.reports",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "report",
"x-connect-usage-class": "report_run",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/reports/open-invoices": {
"get": {
"tags": [
"Reports"
],
"summary": "Open invoices from the branch's QuickBooks Online company",
"description": "date_from and date_to are required and inclusive, and may span at most 366 days. The report lists invoices with a balance dated inside the range in the branch's QuickBooks Online company, joined to their Pulse jobs, exactly as the office Open Invoices report does. An invoice is overdue when its due date is before today in the branch's scheduling zone (Eastern for a branch whose zone is set to UTC). A branch whose QuickBooks Online is not connected, or is blocked, answers 200 with data_available false and unavailable_reason, never an empty report. At most 1,000 invoices are read; is_truncated says when there were more. Customer names and QuickBooks identifiers are not published.",
"operationId": "connectGetOpenInvoicesReport",
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "date_to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectOpenInvoicesReportResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"reports.read"
],
"x-connect-capability": "feature.connectApi.reports",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "report",
"x-connect-usage-class": "report_run",
"x-connect-data-classification": "customer-financial",
"x-connect-requires-idempotency": false
}
},
"/reports/cancelled-customers": {
"get": {
"tags": [
"Reports"
],
"summary": "Service cancellations opened in a date range",
"description": "date_from and date_to are required and inclusive calendar days in the branch's scheduling zone (Eastern for a branch whose zone is set to UTC), and may span at most 366 days. Each item is a Cancel Service ticket opened in the range for one of the branch's customers, as in the office Cancelled Customers report. tenure_bucket is one of `< 3 Months`, `3-6 Months`, `6-12 Months`, `1-2 Years`, `2-5 Years`, `5+ Years`; cancelled_within_60_days compares the cancellation with the first service. Customer and home names, notes and scorecard comments are not published.",
"operationId": "connectGetCancelledCustomersReport",
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "date_to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCancelledCustomersReportResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"reports.read"
],
"x-connect-capability": "feature.connectApi.reports",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "report",
"x-connect-usage-class": "report_run",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/reports/employee-stats": {
"get": {
"tags": [
"Reports"
],
"summary": "Attendance, job, scorecard and productivity statistics per technician",
"description": "date_from and date_to are optional together: send both (inclusive, at most 366 days) or neither, which is the last 180 days in the branch's time zone. Technicians with no termination date are listed; include_terminated adds those whose employment overlapped the range. include_productivity adds productivity rows per service type. Every number is the office Employee Stats report's. Employment dates, pay, time-off balances and photos are not published.",
"operationId": "connectGetEmployeeStatsReport",
"parameters": [
{
"name": "date_from",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "date_to",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "include_terminated",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_productivity",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectEmployeeStatsReportResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"reports.read"
],
"x-connect-capability": "feature.connectApi.reports",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "report",
"x-connect-usage-class": "report_run",
"x-connect-data-classification": "employee-operational",
"x-connect-requires-idempotency": false
}
},
"/quotes/config": {
"get": {
"tags": [
"Quoting"
],
"summary": "Get the branch's booking configuration",
"description": "The services, frequencies, rooms, questions and modifiers the branch offers online, in one call. It never carries hourly rates, time factors, minimums or allowed time. Free: no usage is counted.",
"operationId": "connectGetQuotesConfig",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteConfigResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"pricing.read"
],
"x-connect-capability": "feature.connectApi.sales",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "free",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/quotes/calculate": {
"post": {
"tags": [
"Quoting"
],
"summary": "Calculate instant prices for one service type",
"description": "Final per-visit prices for one service type and the customer's choices. It creates nothing, needs no Idempotency-Key and counts no usage.",
"operationId": "connectCalculateQuote",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"requestBody": {
"x-name": "ConnectQuoteCalculateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteCalculateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteCalculateResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"pricing.read"
],
"x-connect-capability": "feature.connectApi.sales",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "free",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/teams": {
"get": {
"tags": [
"Operations"
],
"summary": "List the branch's teams",
"description": "Teams belonging to the branch, with a count of active members. status takes active or inactive.",
"operationId": "connectListTeams",
"parameters": [
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "status",
"in": "query",
"description": "active or inactive.",
"schema": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectTeamPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"teams.read"
],
"x-connect-capability": "feature.connectApi.operations",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/technicians": {
"get": {
"tags": [
"Operations"
],
"summary": "List the branch's technicians",
"description": "Display name, status, team and skill ids only: no contact details, address, pay or dates. A team_id that GET /teams never lists returns an empty page.",
"operationId": "connectListTechnicians",
"parameters": [
{
"name": "team_id",
"in": "query",
"description": "A team id as listed by GET /teams.",
"schema": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"nullable": true
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "status",
"in": "query",
"description": "active or inactive.",
"schema": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectTechnicianPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"technicians.read"
],
"x-connect-capability": "feature.connectApi.operations",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "employee-operational",
"x-connect-requires-idempotency": false
}
},
"/technicians/{technician_id}": {
"get": {
"tags": [
"Operations"
],
"summary": "Get one technician",
"description": "One branch-owned technician: display name, status, team and skill ids.",
"operationId": "connectGetTechnician",
"parameters": [
{
"name": "technician_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectTechnicianResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"technicians.read"
],
"x-connect-capability": "feature.connectApi.operations",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "employee-operational",
"x-connect-requires-idempotency": false
}
},
"/zones": {
"get": {
"tags": [
"Operations"
],
"summary": "List the branch's zones, optionally with their postal codes",
"description": "Postal codes are included only with include_zips=true, and then a page holds at most 25 rows.",
"operationId": "connectListZones",
"parameters": [
{
"name": "page_size",
"in": "query",
"description": "Zones per page, 1-100; defaults to 50. With include_zips the page is capped at 25 rows: a generated client requesting the default of 50 receives 25 rows and a next cursor.",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "include_zips",
"in": "query",
"description": "Return each zone's postal codes. With include_zips the page is capped at 25 rows: a larger page_size (including the default of 50) returns 25 rows and a next cursor.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectZonePageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"zones.read"
],
"x-connect-capability": "feature.connectApi.operations",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/availability": {
"get": {
"tags": [
"Operations"
],
"summary": "Find bookable arrival windows for the branch",
"description": "Each slot publishes a range of arrival times, never wider than two hours, never later than the last start that still fits the whole job in the gap, and never later than the last start with a technician on shift for all of it — so every time inside the window is bookable and staffed. Dates and times are the branch's scheduling day, which is the time zone GET /branches publishes for every branch with a real zone configured; only a branch whose zone is unset or UTC schedules in US Eastern instead. Today's windows are trimmed to the part still ahead on that clock: one that has partly elapsed starts at the current time, and one that has passed entirely is not returned. A range that has wholly elapsed answers 200 with an empty list, not invalid_request; only an end_date before the start_date is invalid. Three rules decide the range: a start_date in the past is clamped to the branch's today; an omitted end_date is 13 days after that start (14 days inclusive); and a span of more than 31 days, measured after that clamp, is invalid_request. limit is a ceiling, not a promise: a shorter response means the branch had nothing more to offer for that range, and availability is not paged, so there is no cursor to follow. zone_id is a ranking hint that favours slots near existing work in that zone; it does not restrict results to that zone.",
"operationId": "connectGetAvailability",
"parameters": [
{
"name": "start_date",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "end_date",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "duration_hours",
"in": "query",
"schema": {
"type": "number",
"format": "double",
"default": 2.0,
"maximum": 12.0,
"minimum": 0.5
}
},
{
"name": "zone_id",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1.0,
"nullable": true
}
},
{
"name": "team_ids",
"in": "query",
"description": "Comma-separated team ids, at most 50.",
"schema": {
"type": "string",
"pattern": "^[1-9][0-9]*(,[1-9][0-9]*){0,49}$",
"nullable": true
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10,
"maximum": 50.0,
"minimum": 1.0
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectAvailabilityResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"availability.read"
],
"x-connect-capability": "feature.connectApi.operations",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "availability",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/customers/{customer_id}/notes": {
"post": {
"tags": [
"Customers"
],
"summary": "Append a plain-text note to a customer",
"description": "Adds one closed, plain-text note (1-5000 characters) to the customer's history, authored by this API key. Markup answers 400, and notes are never readable through Pulse Connect.",
"operationId": "connectCreateCustomerNote",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1042"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectCustomerNoteCreateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerNoteCreateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerNoteResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customer_notes.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
}
},
"/quotes/{quote_id}/notes": {
"post": {
"tags": [
"Sales"
],
"summary": "Append a plain-text note to a quote",
"description": "Adds one closed, plain-text note (1-5000 characters) to the quote's history, authored by this API key. A lead id is a quote id. A lead moves forward one stage, as in MaidCentral V2: Needs Contacted to Contacted, Quoted to Follow-up.",
"operationId": "connectCreateQuoteNote",
"parameters": [
{
"name": "quote_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "5532"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectQuoteNoteCreateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteNoteCreateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteNoteResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"quote_notes.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
}
},
"/technicians/{technician_id}/notes": {
"post": {
"tags": [
"Operations"
],
"summary": "Append a plain-text note to a technician",
"description": "Adds one closed, plain-text note (1-5000 characters) to the technician's history, authored by this API key.",
"operationId": "connectCreateTechnicianNote",
"parameters": [
{
"name": "technician_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "318"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectTechnicianNoteCreateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectTechnicianNoteCreateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectTechnicianNoteResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"technician_notes.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "employee-operational",
"x-connect-requires-idempotency": true
}
},
"/jobs/{job_id}/move": {
"post": {
"tags": [
"Jobs"
],
"summary": "Move one scheduled visit to a new start",
"description": "scheduled_start_at is YYYY-MM-DDTHH:mm on the branch's scheduling day, the frame GET /availability publishes. Every team linked to the job must offer a staffed arrival window containing it, checked when the move is written. The visit keeps its allowed time and teams; its end is the start plus its allowed time, as the office Move writes it. version is the job's updated_at; a job changed since is refused with version_conflict.",
"operationId": "connectMoveJob",
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "48213"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectJobMoveRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobMoveRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "version_conflict, job_not_eligible, slot_unavailable, idempotency_conflict, or context_not_configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"jobs.change"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": true
}
},
"/jobs/{job_id}/skip": {
"post": {
"tags": [
"Jobs"
],
"summary": "Skip one scheduled visit (customer cancelled) without cancelling the service",
"description": "With charge_fee, the branch's cancellation fee is added to the visit when it is inside the fee window; no payment is taken. A visit with a tip recorded is refused with job_not_eligible. version is the job's updated_at; a job changed since is refused with version_conflict.",
"operationId": "connectSkipJob",
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "48213"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectJobSkipRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobSkipRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "version_conflict, job_not_eligible, slot_unavailable, idempotency_conflict, or context_not_configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"jobs.change"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": true
}
},
"/jobs/{job_id}/cancel": {
"post": {
"tags": [
"Jobs"
],
"summary": "Cancel one scheduled visit (company cancelled) without cancelling the service",
"description": "No fee is charged and no payment is taken or refunded. A cancel takes no reason: the office ticket is filed as Company Cancel Job, as the office cancel does. version is the job's updated_at; a job changed since is refused with version_conflict.",
"operationId": "connectCancelJob",
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "48213"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectJobCancelRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobCancelRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "version_conflict, job_not_eligible, slot_unavailable, idempotency_conflict, or context_not_configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"jobs.change"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": true
}
},
"/jobs/move-reasons": {
"get": {
"tags": [
"Jobs"
],
"summary": "List the move reasons",
"description": "The reason_id values POST /jobs/{job_id}/move accepts: the branch's active move reasons, by name. Free: no usage is counted.",
"operationId": "connectListJobMoveReasons",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectTicketReasonsResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"jobs.change"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "free",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/jobs/skip-reasons": {
"get": {
"tags": [
"Jobs"
],
"summary": "List the skip reasons",
"description": "The reason_id values POST /jobs/{job_id}/skip accepts: the branch's active skip reasons, by name. Free: no usage is counted.",
"operationId": "connectListJobSkipReasons",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectTicketReasonsResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"jobs.change"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "free",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/jobs": {
"get": {
"tags": [
"Jobs"
],
"summary": "List the branch's jobs",
"description": "Jobs in an inclusive date range of at most 366 days, cursor-paged. Statuses are scheduled, in_progress, completed, cancelled, bumped, moved, lock_out and skipped.",
"operationId": "connectListJobs",
"parameters": [
{
"name": "start_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "end_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "status",
"in": "query",
"description": "scheduled, in_progress, completed, cancelled, skipped, moved, lock_out or bumped.",
"schema": {
"type": "string",
"enum": [
"scheduled",
"in_progress",
"completed",
"cancelled",
"skipped",
"moved",
"lock_out",
"bumped"
]
}
},
{
"name": "customer_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "home_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "service_set_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows whose published fields changed on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"jobs.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/jobs/{job_id}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get one job",
"description": "Schedule and operational values only: no payroll, GPS, access instructions or internal notes. Another branch's id answers 404.",
"operationId": "connectGetJob",
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"jobs.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/customers/{customer_id}/jobs": {
"get": {
"tags": [
"Jobs"
],
"summary": "List one customer's jobs",
"description": "The same rows and filters as GET /jobs, narrowed to one customer.",
"operationId": "connectListCustomerJobs",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "start_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "end_date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "status",
"in": "query",
"description": "scheduled, in_progress, completed, cancelled, skipped, moved, lock_out or bumped.",
"schema": {
"type": "string",
"enum": [
"scheduled",
"in_progress",
"completed",
"cancelled",
"skipped",
"moved",
"lock_out",
"bumped"
]
}
},
{
"name": "home_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "service_set_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows whose published fields changed on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"jobs.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-operational",
"x-connect-requires-idempotency": false
}
},
"/homes": {
"get": {
"tags": [
"Homes"
],
"summary": "Export homes for the branch",
"description": "Cursor-paged export of the branch's homes and service addresses. A home is active when it has future pending service work.",
"operationId": "connectListHomes",
"parameters": [
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "customer_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "status",
"in": "query",
"description": "active or inactive.",
"schema": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows whose published fields changed on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectHomePageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"homes.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": false
}
},
"/homes/{home_id}": {
"get": {
"tags": [
"Homes"
],
"summary": "Get one home",
"description": "A home id identifies the customer-home relationship. Another branch's id answers 404.",
"operationId": "connectGetHome",
"parameters": [
{
"name": "home_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectHomeResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"homes.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": false
},
"patch": {
"tags": [
"Homes"
],
"summary": "Rename a home or replace its service address",
"description": "Send expected_updated_at from your last read. Sending address replaces the whole service address, so an omitted line2 clears it.",
"operationId": "connectUpdateHome",
"parameters": [
{
"name": "home_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "2207"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectHomeUpdateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectHomeUpdateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectHomeResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"homes.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
}
},
"/customers/{customer_id}/homes": {
"get": {
"tags": [
"Homes"
],
"summary": "List homes for one customer",
"description": "Needs customers.read and homes.read. status takes active or inactive.",
"operationId": "connectListCustomerHomes",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "status",
"in": "query",
"description": "active or inactive.",
"schema": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows whose published fields changed on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectHomePageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.read",
"homes.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": false
},
"post": {
"tags": [
"Homes"
],
"summary": "Add a service address to a customer; its zone comes from the postal code",
"description": "A postal code with no service zone in the branch, or outside the franchise territory, answers 400 invalid_request. country_code is US when absent.",
"operationId": "connectCreateCustomerHome",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1042"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectHomeCreateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectHomeCreateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectHomeResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"homes.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
}
},
"/customers": {
"get": {
"tags": [
"Customers"
],
"summary": "Export customers for the branch",
"description": "Cursor-paged export of the branch's customers. created_from and created_to are branch-local dates.",
"operationId": "connectListCustomers",
"parameters": [
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "status",
"in": "query",
"description": "lead, active_recurring, active_one_time, inactive, closed_lost or locked.",
"schema": {
"type": "string",
"enum": [
"lead",
"active_recurring",
"active_one_time",
"inactive",
"closed_lost",
"locked"
]
}
},
{
"name": "created_from",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "created_to",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows whose published fields changed on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": false
},
"post": {
"tags": [
"Customers"
],
"summary": "Create a customer with the approved name and contact fields",
"description": "Runs the same validation and duplicate checks as adding a customer in Pulse: another customer in the branch with this email or phone answers 409 duplicate_customer.",
"operationId": "connectCreateCustomer",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectCustomerCreateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerCreateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
}
},
"/customers/lookup": {
"get": {
"tags": [
"Customers"
],
"summary": "Find a bounded set of customers",
"description": "At most 20 customers matching query by exact email, exact normalized phone, or bounded name and company matching.",
"operationId": "connectLookupCustomers",
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerLookupResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": false
}
},
"/customers/{customer_id}": {
"get": {
"tags": [
"Customers"
],
"summary": "Get one customer",
"description": "An unknown id and another branch's id both answer 404 resource_not_found.",
"operationId": "connectGetCustomer",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": false
},
"patch": {
"tags": [
"Customers"
],
"summary": "Change a customer's approved name and contact fields",
"description": "Send expected_updated_at from your last read; a customer changed since answers 409 version_conflict. A field you leave out keeps its value, and an empty company_name clears it.",
"operationId": "connectUpdateCustomer",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1042"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectCustomerUpdateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerUpdateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
}
},
"/tags": {
"get": {
"tags": [
"Customers"
],
"summary": "List the branch's customer tags",
"description": "The customer tags a customer's tag_ids refer to, including MaidCentral-wide tags and tags the office has turned off (active: false). status takes active or inactive.",
"operationId": "connectListTags",
"parameters": [
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "status",
"in": "query",
"description": "active or inactive.",
"schema": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectTagPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"tags.read"
],
"x-connect-capability": "feature.connectApi.bulkReads",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "operational",
"x-connect-requires-idempotency": false
}
},
"/customers/{customer_id}/tags/{tag_id}": {
"post": {
"tags": [
"Customers"
],
"summary": "Add a tag to a customer",
"description": "Adds an active tag from GET /tags. A tag the customer already has changes nothing and answers 200. An inactive or unknown tag, another company's tag, or another branch's customer answers 404. A tag another branch of your company created is accepted.",
"operationId": "connectApplyCustomerTag",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tag_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
},
"delete": {
"tags": [
"Customers"
],
"summary": "Remove a tag from a customer",
"description": "Removes a tag from GET /tags, active or not. A tag the customer does not have changes nothing and answers 200. An unknown tag, another company's tag, or another branch's customer answers 404. A tag another branch of your company created is accepted.",
"operationId": "connectRemoveCustomerTag",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tag_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured, the idempotency key was used with a different body, the resource changed since it was read (version_conflict), or the customer already exists (duplicate_customer).",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
}
},
"/customers/{customer_id}/consent": {
"patch": {
"tags": [
"Customers"
],
"summary": "Record a customer's SMS or marketing opt-in with its source, or an SMS or email opt-out",
"description": "Each field is true or left out. An opt-in while the customer is opted out on a channel it covers answers 409 contact_opted_out and changes nothing: only the customer or the office can opt them back in. Takes no expected_updated_at, so an opt-out is never refused for a stale read.",
"operationId": "connectUpdateCustomerConsent",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1042"
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"description": "Caller-generated key; replaying it returns the first response.",
"schema": {
"type": "string",
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]{1,128}$"
}
}
],
"requestBody": {
"x-name": "ConnectCustomerConsentRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerConsentRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "contact_opted_out (the customer opted out on a channel the opt-in covers; only the customer or the office can opt them back in), idempotency_conflict, or context_not_configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Request body exceeds 64 KB, or the response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.write"
],
"x-connect-capability": "feature.connectApi.writes",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "write",
"x-connect-usage-class": "core_write",
"x-connect-data-classification": "customer-pii",
"x-connect-requires-idempotency": true
}
},
"/me": {
"get": {
"tags": [
"Context"
],
"summary": "Get the authenticated Connect context",
"description": "The branch and credential this key authenticates as, its granted scopes, and the contract version. Free: no usage is counted.",
"operationId": "connectGetMe",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectMeResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [],
"x-connect-capability": "feature.connectApi",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "context",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": false
}
},
"/branches": {
"get": {
"tags": [
"Context"
],
"summary": "List branches visible to this credential",
"description": "The single branch this branch-bound key reads, with its time zone and currency. Free: no usage is counted.",
"operationId": "connectListBranches",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectBranchesResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [],
"x-connect-capability": "feature.connectApi",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "context",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": false
}
},
"/capabilities": {
"get": {
"tags": [
"Context"
],
"summary": "Get the public capabilities this API serves for the branch, and its constraints",
"description": "Which capability families are on for the branch, and constraints such as the maximum page size, the maximum response size and the webhook subscription limit. Free: no usage is counted.",
"operationId": "connectGetCapabilities",
"parameters": [
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCapabilitiesResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [],
"x-connect-capability": "feature.connectApi",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "context",
"x-connect-usage-class": "free",
"x-connect-data-classification": "metadata",
"x-connect-requires-idempotency": false
}
},
"/customers/{customer_id}/invoices": {
"get": {
"tags": [
"Billing"
],
"summary": "List one customer's invoices",
"description": "The customer's invoices from both ledgers, paged by number (page, has_more). For a QuickBooks-synced invoice, status, balance and amount_paid are reconciled against QuickBooks at read time.",
"operationId": "connectListCustomerInvoices",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectInvoicePageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.read",
"billing.read"
],
"x-connect-capability": "feature.connectApi.billing",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-financial",
"x-connect-requires-idempotency": false
}
},
"/customers/{customer_id}/invoices/{invoice_id}": {
"get": {
"tags": [
"Billing"
],
"summary": "Get one of a customer's invoices",
"description": "Customer-scoped because half the billing union is legacy work whose invoice id exists in no table. Every id this API publishes arrives on a row that carries its customer_id.",
"operationId": "connectGetInvoice",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "invoice_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectInvoiceResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.read",
"billing.read"
],
"x-connect-capability": "feature.connectApi.billing",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-financial",
"x-connect-requires-idempotency": false
}
},
"/customers/{customer_id}/payments": {
"get": {
"tags": [
"Billing"
],
"summary": "List one customer's payments",
"description": "Settled payments only, paged by number. A declined, pending, voided or refunded payment is not listed, so a payment's absence is not evidence that it failed.",
"operationId": "connectListCustomerPayments",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectPaymentPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.read",
"billing.read"
],
"x-connect-capability": "feature.connectApi.billing",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-financial",
"x-connect-requires-idempotency": false
}
},
"/customers/{customer_id}/billing": {
"get": {
"tags": [
"Billing"
],
"summary": "Get one customer's balance and last payment",
"description": "Balance, available credit, open and overdue invoice counts, and the last payment. The counts use stored balances, so they can briefly lag an invoice settled directly in QuickBooks.",
"operationId": "connectGetCustomerBilling",
"parameters": [
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerBillingResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"customers.read",
"billing.read"
],
"x-connect-capability": "feature.connectApi.billing",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "core-read",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-financial",
"x-connect-requires-idempotency": false
}
},
"/invoices": {
"get": {
"tags": [
"Billing"
],
"summary": "List the branch's invoices",
"description": "The same two-ledger union the per-customer lists publish, branch-wide and cursor-paged: a row here is the row GET /customers/{customer_id}/invoices or /payments publishes, with its stored balance and status (not reconciled against QuickBooks at read time).",
"operationId": "connectListInvoices",
"parameters": [
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows modified on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectInvoiceCursorPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"billing.read"
],
"x-connect-capability": "feature.connectApi.billing",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "report",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-financial",
"x-connect-requires-idempotency": false
}
},
"/payments": {
"get": {
"tags": [
"Billing"
],
"summary": "List the branch's settled payments",
"description": "The same two-ledger union the per-customer lists publish, branch-wide and cursor-paged: a row here is the row GET /customers/{customer_id}/invoices or /payments publishes, with its stored balance and status (not reconciled against QuickBooks at read time).",
"operationId": "connectListPayments",
"parameters": [
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100.0,
"minimum": 1.0
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "updated_since",
"in": "query",
"description": "Branch-local calendar date (YYYY-MM-DD). Rows modified on or after that day in the branch's own timezone.",
"schema": {
"type": "string",
"format": "date",
"nullable": true
}
},
{
"name": "X-Correlation-Id",
"in": "header",
"description": "Optional caller correlation ID; generated and echoed when absent.",
"schema": {
"type": "string",
"maxLength": 128
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Pulse-Connect-Usage-Warning": {
"type": "string",
"description": "Present when the branch soft allowance is reached."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectPaymentCursorPageResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Invalid request.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"404": {
"description": "Resource not found.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"409": {
"description": "Connect context is not configured.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
},
"RateLimit-Limit": {
"type": "string",
"description": "Applicable request limit."
},
"RateLimit-Remaining": {
"type": "string",
"description": "Remaining requests."
},
"RateLimit-Reset": {
"type": "string",
"description": "UTC epoch seconds when the limiting window resets."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"500": {
"description": "Internal error.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"503": {
"description": "Distributed protection or another required service is unavailable.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
},
"Retry-After": {
"type": "string",
"description": "Seconds before retrying."
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
},
"413": {
"description": "Response exceeds the public size boundary.",
"headers": {
"X-Correlation-Id": {
"type": "string",
"description": "Caller-provided or generated correlation ID."
},
"Pulse-Connect-Operation-Id": {
"type": "string",
"description": "Authenticated Connect operation ID.",
"pattern": "^op_[0-9a-f]{32}$"
}
},
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"error_code",
"correlation_id"
],
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "integer",
"maximum": 599.0,
"minimum": 400.0
},
"error_code": {
"type": "string",
"enum": [
"invalid_request",
"invalid_cursor",
"invalid_credentials",
"insufficient_scope",
"capability_not_enabled",
"context_not_configured",
"resource_not_found",
"idempotency_key_required",
"idempotency_conflict",
"version_conflict",
"duplicate_customer",
"contact_opted_out",
"quote_converted",
"lead_booked",
"quote_not_priced",
"quote_expired",
"quote_not_bookable",
"payments_not_configured",
"job_not_eligible",
"service_not_eligible",
"slot_unavailable",
"request_too_large",
"result_too_large",
"rate_limited",
"internal_error",
"service_unavailable",
"report_timeout"
]
},
"correlation_id": {
"type": "string",
"maxLength": 128
},
"detail": {
"type": "string",
"maxLength": 1000,
"nullable": true
},
"instance": {
"type": "string",
"maxLength": 500,
"nullable": true
}
}
}
}
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-connect-scope": [
"billing.read"
],
"x-connect-capability": "feature.connectApi.billing",
"x-connect-branch-mode": "credential",
"x-connect-rate-class": "report",
"x-connect-usage-class": "core_read",
"x-connect-data-classification": "customer-financial",
"x-connect-requires-idempotency": false
}
}
},
"components": {
"schemas": {
"ConnectWebhookEventCatalogResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The events this key holds the scope to subscribe to.",
"items": {
"$ref": "#/components/schemas/ConnectWebhookEventResponse"
}
}
}
},
"ConnectWebhookEventResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"event_type": {
"type": "string",
"description": "The event's name, to list in a subscription's event_types.",
"maxLength": 60,
"minLength": 0,
"pattern": "^(customer\\.created|customer\\.status_changed|job\\.scheduled|job\\.started|job\\.completed|job\\.cancelled|job\\.rescheduled|service\\.cancelled|lead\\.created|lead\\.converted|lead\\.closed|quote\\.revised|payment_method\\.saved|job\\.on_the_way|invoice\\.created|invoice\\.paid|payment\\.received|scorecard\\.submitted)$"
},
"resource_type": {
"type": "string",
"description": "The type of resource the event's resource identifies.",
"maxLength": 30,
"minLength": 0
},
"required_scope": {
"type": "string",
"description": "The scope a key needs to subscribe to the event.",
"maxLength": 60,
"minLength": 0
},
"version": {
"type": "integer",
"description": "The envelope version deliveries of this event carry as version.",
"format": "int32"
}
}
},
"ConnectWebhookCreatedResponse": {
"type": "object",
"description": "Returned by create and rotate only. secret is never shown again.",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The subscription's id; read it with GET /webhooks/{webhook_id}.",
"maxLength": 40,
"minLength": 0
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"url": {
"type": "string",
"description": "The public HTTPS URL deliveries are sent to.",
"maxLength": 2000,
"minLength": 0
},
"description": {
"type": "string",
"description": "The subscription's description; null when none was set.",
"maxLength": 200,
"minLength": 0,
"nullable": true
},
"event_types": {
"type": "array",
"description": "The events the subscription receives, as GET /webhook-events names them.",
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"description": "active, or paused while events queue and nothing is sent.",
"pattern": "^(active|paused)$"
},
"secret": {
"type": "string",
"description": "The signing secret for verifying deliveries, shown only in this response; store it.",
"maxLength": 80,
"minLength": 0
},
"created_at": {
"type": "string",
"description": "When the subscription was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "When the subscription was last changed (UTC).",
"format": "date-time"
}
}
},
"ConnectWebhookCreateRequest": {
"type": "object",
"example": {
"url": "https://example.com/pulse-webhooks",
"description": "CRM sync",
"event_types": [
"lead.created",
"job.completed"
]
},
"additionalProperties": false,
"properties": {
"url": {
"type": "string",
"nullable": true,
"example": "https://example.com/pulse-webhooks"
},
"description": {
"type": "string",
"nullable": true,
"example": "CRM sync"
},
"event_types": {
"type": "array",
"example": [
"lead.created",
"job.completed"
],
"items": {
"type": "string"
}
}
}
},
"ConnectWebhookPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectWebhookResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectWebhookResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The subscription's id; read it with GET /webhooks/{webhook_id}.",
"maxLength": 40,
"minLength": 0
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"url": {
"type": "string",
"description": "The public HTTPS URL deliveries are sent to.",
"maxLength": 2000,
"minLength": 0
},
"description": {
"type": "string",
"description": "The subscription's description; null when none was set.",
"maxLength": 200,
"minLength": 0,
"nullable": true
},
"event_types": {
"type": "array",
"description": "The events the subscription receives, as GET /webhook-events names them.",
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"description": "active, or paused while events queue and nothing is sent.",
"pattern": "^(active|paused)$"
},
"paused_reason": {
"type": "string",
"description": "Why the subscription is paused: operator, auto or credential; null while active.",
"pattern": "^(operator|auto|credential)$",
"nullable": true
},
"created_at": {
"type": "string",
"description": "When the subscription was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "When the subscription was last changed (UTC).",
"format": "date-time"
}
}
},
"ConnectWebhookListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectWebhookIdRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectWebhookUpdateRequest": {
"type": "object",
"example": {
"url": null,
"description": null,
"event_types": [
"lead.created",
"job.completed",
"quote.revised"
],
"paused": null
},
"additionalProperties": false,
"properties": {
"url": {
"type": "string",
"nullable": true,
"example": null
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"event_types": {
"type": "array",
"nullable": true,
"example": [
"lead.created",
"job.completed",
"quote.revised"
],
"items": {
"type": "string"
}
},
"paused": {
"type": "boolean",
"nullable": true,
"example": null
}
}
},
"ConnectWebhookDeliveryResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The delivery's id.",
"maxLength": 40,
"minLength": 0
},
"event_id": {
"type": "string",
"description": "The delivered event's id, the same value as the envelope's id and the Pulse-Connect-Event-Id header.",
"maxLength": 40,
"minLength": 0
},
"event_type": {
"type": "string",
"description": "The delivered event's name.",
"maxLength": 60,
"minLength": 0
},
"state": {
"type": "string",
"description": "The delivery's state: pending, in_flight, delivered, dead_letter or cancelled.",
"pattern": "^(pending|in_flight|delivered|dead_letter|cancelled)$"
},
"attempt_count": {
"type": "integer",
"description": "How many delivery attempts have been made.",
"format": "int32"
},
"last_attempt_at": {
"type": "string",
"description": "When the latest attempt started (UTC); null before the first attempt.",
"format": "date-time",
"nullable": true
},
"last_http_status": {
"type": "integer",
"description": "The HTTP status your endpoint answered on the latest attempt; null when there was no attempt or no response.",
"format": "int32",
"nullable": true
},
"last_error_category": {
"type": "string",
"description": "Why the latest attempt failed, such as http_rejected, http_retryable, dns, timeout or network; null when it did not fail or no attempt was made.",
"maxLength": 60,
"minLength": 0,
"nullable": true
},
"created_at": {
"type": "string",
"description": "When the delivery was queued (UTC).",
"format": "date-time"
}
}
},
"ConnectWebhookDeliveryPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectWebhookDeliveryResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectWebhookDeliveryListRequest": {
"allOf": [
{
"$ref": "#/components/schemas/ConnectWebhookListRequest"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ConnectUsageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id.",
"maxLength": 100,
"minLength": 1
},
"period_start": {
"type": "string",
"description": "The start of the current UTC calendar month the usage covers (UTC).",
"format": "date-time"
},
"period_end": {
"type": "string",
"description": "The last instant of the current UTC calendar month, just before reset_at (UTC).",
"format": "date-time"
},
"as_of": {
"type": "string",
"description": "The latest accounting watermark reflected in these figures (UTC); the response time when the month has no metered operation yet.",
"format": "date-time"
},
"allowance": {
"type": "integer",
"description": "The branch's monthly operation allowance; 0 when none is set.",
"format": "int64",
"maximum": 9223372036854780000.0,
"minimum": 0.0
},
"consumed": {
"type": "integer",
"description": "The successful metered operations counted this UTC month, shared by every key on the branch.",
"format": "int64",
"maximum": 9223372036854780000.0,
"minimum": 0.0
},
"remaining": {
"type": "integer",
"description": "The allowance minus consumed, never below 0.",
"format": "int64",
"maximum": 9223372036854780000.0,
"minimum": 0.0
},
"percent_used": {
"type": "number",
"description": "Consumed as a percentage of the allowance; 0 when no allowance is set.",
"format": "double",
"minimum": 0.0
},
"soft_limit": {
"type": "boolean",
"description": "Always true: the allowance is soft, so requests keep working past it."
},
"alerts_reached": {
"type": "array",
"description": "The percentages of the allowance (50, 80, 100) this month's usage has reached; empty when no allowance is set.",
"items": {
"type": "integer",
"format": "int32"
}
},
"reset_at": {
"type": "string",
"description": "When usage resets: the start of the next UTC month (UTC).",
"format": "date-time"
},
"accounting_delay_seconds": {
"type": "integer",
"description": "The response time minus as_of, in seconds.",
"format": "int32",
"maximum": 2147483647.0,
"minimum": 0.0
},
"reconciliation_status": {
"type": "string",
"description": "current when accounting is up to date, pending during the normal five-minute ingestion window, or degraded when it lags more than five minutes or its health cannot be established.",
"pattern": "^(current|pending|degraded)$"
},
"breakdown": {
"type": "array",
"description": "Consumed, grouped by OpenAPI operation id and usage class.",
"items": {
"$ref": "#/components/schemas/ConnectUsageBreakdownResponse"
}
}
}
},
"ConnectUsageBreakdownResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"operation_key": {
"type": "string",
"description": "The OpenAPI operation id the operations were counted against.",
"maxLength": 100,
"minLength": 0
},
"usage_class": {
"type": "string",
"description": "The usage class the operations count in: core_read, core_write or report_run.",
"pattern": "^(core_read|core_write|payment|report_run)$"
},
"count": {
"type": "integer",
"description": "How many successful metered operations of this operation and class were counted this month.",
"format": "int64",
"maximum": 9223372036854780000.0,
"minimum": 0.0
}
}
},
"ConnectDailyTimeSummaryPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectDailyTimeSummaryResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectDailyTimeSummaryResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"technician_id": {
"type": "string",
"description": "The technician's id; read it with GET /technicians/{technician_id}."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"work_date": {
"type": "string",
"description": "The branch-local day the technician clocked in on; a shift past midnight belongs wholly to that day.",
"format": "date"
},
"worked_minutes": {
"type": "integer",
"description": "The day's closed clock entries in whole minutes, unpaid breaks excluded and paid breaks included.",
"format": "int32",
"maximum": 2147483647.0,
"minimum": 0.0
},
"has_open_entry": {
"type": "boolean",
"description": "True when a clock entry for the day is still open; that entry counts 0 in worked_minutes."
}
}
},
"ConnectTimeSummaryListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectJobTimeSummaryPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectJobTimeSummaryResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectJobTimeSummaryResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"job_id": {
"type": "string",
"description": "The job's id; read it with GET /jobs/{job_id}."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"work_date": {
"type": "string",
"description": "The job's branch-local job_date, as GET /jobs publishes it.",
"format": "date"
},
"worked_minutes": {
"type": "integer",
"description": "The job's closed timesheet entries in whole minutes; breaks are never deducted.",
"format": "int32",
"maximum": 2147483647.0,
"minimum": 0.0
},
"has_open_entry": {
"type": "boolean",
"description": "True when any timesheet entry on the job is still open; open entries count 0 in worked_minutes."
},
"technicians": {
"type": "array",
"description": "Each technician's total on the job; only the requested technician when technician_id is set.",
"items": {
"$ref": "#/components/schemas/ConnectJobTechnicianTimeResponse"
}
}
}
},
"ConnectJobTechnicianTimeResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"technician_id": {
"type": "string",
"description": "The technician's id; read it with GET /technicians/{technician_id}."
},
"worked_minutes": {
"type": "integer",
"description": "The technician's closed timesheet entries on the job in whole minutes; breaks are never deducted.",
"format": "int32",
"maximum": 2147483647.0,
"minimum": 0.0
},
"has_open_entry": {
"type": "boolean",
"description": "True when the technician's timesheet entry on the job is still open; it counts 0 in worked_minutes."
}
}
},
"ConnectServiceSetResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The service set's id; read it with GET /service-sets/{service_set_id}."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"created_at": {
"type": "string",
"description": "When the service set was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The latest change to the service set, its base fees or its rate modifications (UTC); send it as version on POST /service-sets/{service_set_id}/cancel.",
"format": "date-time"
},
"customer_id": {
"type": "string",
"description": "The customer the service set is for; read it with GET /customers/{customer_id}."
},
"home_id": {
"type": "string",
"description": "The home the service set is attached to; read it with GET /homes/{home_id}."
},
"description": {
"type": "string",
"description": "The service set's description, trimmed.",
"maxLength": 50,
"minLength": 0
},
"status": {
"type": "string",
"description": "active when the service set has a future pending job in the branch's timezone; otherwise inactive.",
"pattern": "^(active|inactive)$"
},
"service_type_id": {
"type": "string",
"description": "The service type's id; null when the service type is not one the branch owns.",
"nullable": true
},
"service_type": {
"type": "string",
"description": "The service type's name; null when the service type is not one the branch owns.",
"maxLength": 200,
"minLength": 0,
"nullable": true
},
"frequency": {
"type": "string",
"description": "How often the service recurs, from its latest base fee: weekly, every_two_weeks, every_three_weeks, every_four_weeks, other_recurring, quarterly, yearly, one_time or unknown.",
"pattern": "^(weekly|every_two_weeks|every_three_weeks|every_four_weeks|other_recurring|quarterly|yearly|one_time|unknown)$"
},
"is_recurring": {
"type": "boolean",
"description": "True for every recurring frequency; false for one_time and unknown."
},
"current_price": {
"type": "number",
"description": "The current per-visit price in currency_code: the latest base fee plus active rate modifications; null when the service set has no base fee history.",
"format": "decimal",
"nullable": true
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
}
}
},
"ConnectServiceSetCancelRequest": {
"type": "object",
"example": {
"version": "2026-10-30T14:12:08.443Z",
"effective_date": "2026-11-05",
"reason_id": "17",
"notes": "Customer is moving away"
},
"additionalProperties": false,
"required": [
"version",
"effective_date",
"reason_id"
],
"properties": {
"version": {
"type": "string",
"description": "The service set's updated_at as last read. A service set changed since is refused.",
"minLength": 1,
"example": "2026-10-30T14:12:08.443Z"
},
"effective_date": {
"type": "string",
"description": "YYYY-MM-DD on the branch's calendar; the cancel starts at the first scheduled visit on or after it.",
"minLength": 1,
"example": "2026-11-05"
},
"reason_id": {
"type": "string",
"description": "Required office reason: the id of one of the branch's active Cancel Service reasons.",
"minLength": 1,
"example": "17"
},
"notes": {
"type": "string",
"description": "Optional note for the office ticket, at most 500 characters.",
"nullable": true,
"example": "Customer is moving away"
}
}
},
"ConnectTicketReasonsResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The active reasons, ordered by name, then id; every listed id is accepted as reason_id.",
"items": {
"$ref": "#/components/schemas/ConnectTicketReasonResponse"
}
}
}
},
"ConnectTicketReasonResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The reason's id; send it as reason_id on the matching action."
},
"name": {
"type": "string",
"description": "The reason's name as the office shows it.",
"maxLength": 50,
"minLength": 0
}
}
},
"ConnectServiceSetPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectServiceSetResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectServiceSetListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectServiceSetDetailRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectCustomerServiceSetListRequest": {
"allOf": [
{
"$ref": "#/components/schemas/ConnectServiceSetListRequest"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ConnectScorecardPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectScorecardResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectScorecardResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The rating's id; the same id a scorecard.submitted event carries as resource.id."
},
"job_id": {
"type": "string",
"description": "The rated job; read it with GET /jobs/{job_id}."
},
"customer_id": {
"type": "string",
"description": "The customer who rated the job; read it with GET /customers/{customer_id}."
},
"rating": {
"type": "integer",
"description": "The rating from 1 (worst) to 5 (best).",
"format": "int32",
"maximum": 5.0,
"minimum": 1.0
},
"submitted_at": {
"type": "string",
"description": "The UTC minute the rating was submitted; a re-rate moves it to the new time.",
"format": "date-time"
}
}
},
"ConnectScorecardListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectLeadResponse": {
"type": "object",
"description": "A prospect. No street address, no access or pet instructions, no payment-processor customer\nids — the postal code is kept because territory routing is why an integration asks at all.\nstatus_name and source_name are null when the branch has no label configured or\nthe label belongs to another tenant (withheld).",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The lead's id, which is also its quote id; read it with GET /leads/{lead_id}."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"customer_id": {
"type": "string",
"description": "The customer the prospect became; null on a lead, since a converted prospect leaves /leads.",
"nullable": true
},
"status_name": {
"type": "string",
"description": "The lead's status, as the branch's own label rather than an enum.",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"source_name": {
"type": "string",
"description": "How the prospect heard about the business, as the branch's own customer-source label.",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"postal_code": {
"type": "string",
"description": "The prospect's postal code; the street address is not published.",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"medium": {
"type": "string",
"description": "How the prospect reached the business: web, web_widget, portal, phone, sms, email or unknown (nothing recorded).",
"pattern": "^(web|web_widget|portal|phone|sms|email|unknown)$"
},
"attribution": {
"description": "The first-touch marketing attribution captured at creation; null when none was captured.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConnectLeadAttributionResponse"
}
]
},
"closed_reason": {
"type": "string",
"description": "The note saved when the lead was closed, as Pulse stores it (line breaks as
); null while the lead is open.",
"nullable": true
},
"created_at": {
"type": "string",
"description": "When the lead was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The later of the lead's last change and its newest contact change (UTC); send it as expected_updated_at on PATCH /leads/{lead_id}.",
"format": "date-time"
}
}
},
"ConnectLeadAttributionResponse": {
"type": "object",
"description": "First-touch marketing attribution, captured once when the prospect was created and never\nchanged. Null when none was captured. Each value is what the integration or web form sent.",
"additionalProperties": false,
"properties": {
"utm_source": {
"type": "string",
"description": "The utm_source value captured.",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"utm_medium": {
"type": "string",
"description": "The utm_medium value captured.",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"utm_campaign": {
"type": "string",
"description": "The utm_campaign value captured.",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"utm_term": {
"type": "string",
"description": "The utm_term value captured.",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"utm_content": {
"type": "string",
"description": "The utm_content value captured.",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"gclid": {
"type": "string",
"description": "The Google Ads click id (gclid) captured.",
"maxLength": 255,
"minLength": 0,
"nullable": true
},
"fbclid": {
"type": "string",
"description": "The Facebook click id (fbclid) captured.",
"maxLength": 255,
"minLength": 0,
"nullable": true
}
}
},
"ConnectLeadCreateRequest": {
"type": "object",
"example": {
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"phone": "5551234567",
"address": {
"line1": "12 Main St",
"line2": null,
"city": "Denver",
"region": "CO",
"postal_code": "80202"
},
"medium": "web",
"source_name": "Google",
"attribution": {
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring",
"utm_term": null,
"utm_content": null,
"gclid": "Cj0KCQ",
"fbclid": null
},
"home": {
"square_footage": 1800,
"stories": null,
"bedrooms": 3,
"full_bathrooms": 2,
"half_bathrooms": null,
"pets": null,
"people": null,
"has_basement": null,
"dirt_level": null
}
},
"additionalProperties": false,
"properties": {
"first_name": {
"type": "string",
"maxLength": 60,
"minLength": 0,
"nullable": true,
"example": "Ada"
},
"last_name": {
"type": "string",
"maxLength": 60,
"minLength": 0,
"nullable": true,
"example": "Lovelace"
},
"email": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": "ada@example.com"
},
"phone": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": "5551234567"
},
"address": {
"description": "Optional. A postal code outside the branch's zones is accepted and tagged Out of Service Area.",
"nullable": true,
"example": {
"line1": "12 Main St",
"line2": null,
"city": "Denver",
"region": "CO",
"postal_code": "80202"
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectLeadAddressRequest"
}
]
},
"medium": {
"type": "string",
"description": "How the prospect reached the business; unknown when absent.",
"pattern": "^(web|web_widget|portal|phone|sms|email|unknown)$",
"nullable": true,
"example": "web"
},
"source_name": {
"type": "string",
"description": "One of the branch's customer sources (\"How did you hear about us?\").",
"maxLength": 100,
"minLength": 0,
"nullable": true,
"example": "Google"
},
"attribution": {
"description": "First-touch marketing attribution. Accepted only here; it is never changed afterwards.",
"nullable": true,
"example": {
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring",
"utm_term": null,
"utm_content": null,
"gclid": "Cj0KCQ",
"fbclid": null
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectLeadAttributionRequest"
}
]
},
"home": {
"nullable": true,
"example": {
"square_footage": 1800,
"stories": null,
"bedrooms": 3,
"full_bathrooms": 2,
"half_bathrooms": null,
"pets": null,
"people": null,
"has_basement": null,
"dirt_level": null
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectLeadHomeRequest"
}
]
}
}
},
"ConnectLeadAddressRequest": {
"type": "object",
"description": "A prospect's service address. Every part is optional and there is no country: a lead takes\nthe branch's country, as V2's lead API writes it.",
"additionalProperties": false,
"properties": {
"line1": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"line2": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"region": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"postal_code": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true
}
}
},
"ConnectLeadAttributionRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"utm_source": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"utm_medium": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"utm_campaign": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"utm_term": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"utm_content": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"gclid": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"nullable": true
},
"fbclid": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"nullable": true
}
}
},
"ConnectLeadHomeRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"square_footage": {
"type": "integer",
"format": "int32",
"maximum": 100000.0,
"minimum": 0.0,
"nullable": true
},
"stories": {
"type": "number",
"format": "double",
"maximum": 20.0,
"minimum": 0.0,
"nullable": true
},
"bedrooms": {
"type": "integer",
"format": "int32",
"maximum": 50.0,
"minimum": 0.0,
"nullable": true
},
"full_bathrooms": {
"type": "integer",
"format": "int32",
"maximum": 50.0,
"minimum": 0.0,
"nullable": true
},
"half_bathrooms": {
"type": "integer",
"format": "int32",
"maximum": 50.0,
"minimum": 0.0,
"nullable": true
},
"pets": {
"type": "integer",
"format": "int32",
"maximum": 50.0,
"minimum": 0.0,
"nullable": true
},
"people": {
"type": "integer",
"format": "int32",
"maximum": 50.0,
"minimum": 0.0,
"nullable": true
},
"has_basement": {
"type": "boolean",
"nullable": true
},
"dirt_level": {
"type": "integer",
"format": "int32",
"maximum": 10.0,
"minimum": 0.0,
"nullable": true
}
}
},
"ConnectLeadUpdateRequest": {
"type": "object",
"example": {
"expected_updated_at": "2026-10-22T15:04:05+00:00",
"first_name": null,
"last_name": null,
"email": null,
"phone": "5550000000",
"home": {
"square_footage": null,
"stories": null,
"bedrooms": 4,
"full_bathrooms": null,
"half_bathrooms": null,
"pets": null,
"people": null,
"has_basement": null,
"dirt_level": null
},
"attribution": null
},
"additionalProperties": false,
"properties": {
"expected_updated_at": {
"type": "string",
"description": "The updated_at this client last read; a newer write answers 409 version_conflict.",
"format": "date-time",
"nullable": true,
"example": "2026-10-22T15:04:05+00:00"
},
"first_name": {
"type": "string",
"maxLength": 60,
"minLength": 0,
"nullable": true,
"example": null
},
"last_name": {
"type": "string",
"maxLength": 60,
"minLength": 0,
"nullable": true,
"example": null
},
"email": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": null
},
"phone": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": "5550000000"
},
"home": {
"description": "Only the statistics present change.",
"nullable": true,
"example": {
"square_footage": null,
"stories": null,
"bedrooms": 4,
"full_bathrooms": null,
"half_bathrooms": null,
"pets": null,
"people": null,
"has_basement": null,
"dirt_level": null
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectLeadHomeRequest"
}
]
},
"attribution": {
"description": "Not accepted: attribution is set once, when the lead is created. Present answers 400.",
"nullable": true,
"example": null
}
}
},
"ConnectLeadCloseRequest": {
"type": "object",
"example": {
"expected_updated_at": "2026-10-22T15:04:05+00:00",
"reason": "Chose a competitor",
"notes": "Price was the deciding factor."
},
"additionalProperties": false,
"properties": {
"expected_updated_at": {
"type": "string",
"description": "The updated_at this client last read; a newer write answers 409 version_conflict.",
"format": "date-time",
"nullable": true,
"example": "2026-10-22T15:04:05+00:00"
},
"reason": {
"type": "string",
"description": "Required. Why the prospect was lost, in plain text. Saved as a note on the lead.",
"maxLength": 500,
"minLength": 0,
"nullable": true,
"example": "Chose a competitor"
},
"notes": {
"type": "string",
"description": "Optional plain-text detail, saved in the same note after a blank line.",
"maxLength": 4000,
"minLength": 0,
"nullable": true,
"example": "Price was the deciding factor."
}
}
},
"ConnectQuoteBookingResponse": {
"type": "object",
"description": "The booked quote, the new recurring service set, and the confirmed first visit.",
"additionalProperties": false,
"properties": {
"quote": {
"description": "The booked quote, in the shape GET /quotes/{quote_id} returns.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectQuoteResponse"
}
]
},
"service_set_id": {
"type": "string",
"description": "The new service set's id; read it with GET /service-sets/{service_set_id}."
},
"first_job": {
"description": "The confirmed first visit, in the shape GET /jobs/{job_id} returns.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectJobResponse"
}
]
}
}
},
"ConnectQuoteResponse": {
"type": "object",
"description": "Status travels as the branch's own name rather than an enum: quote statuses are per-branch\nconfiguration, so a fixed set invented here would be wrong for somebody. status_name and\nsource_name are null when the branch has no label configured or the label belongs to\nanother tenant (withheld).",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The quote's id, which is also its lead id; read it with GET /quotes/{quote_id}."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"customer_id": {
"type": "string",
"description": "The customer the prospect became, readable with GET /customers/{customer_id}; null until the quote is converted.",
"nullable": true
},
"status_name": {
"type": "string",
"description": "The quote's status, as the branch's own label rather than an enum.",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"source_name": {
"type": "string",
"description": "How the prospect heard about the business, as the branch's own customer-source label.",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"job_rate": {
"type": "number",
"description": "The quote's base rate before modifiers, in currency_code.",
"format": "decimal",
"nullable": true
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"first_job_date": {
"type": "string",
"description": "The first visit's date, a branch-local calendar date.",
"format": "date",
"nullable": true
},
"booked_date": {
"type": "string",
"description": "When the quote was booked (UTC); null while it is not booked.",
"format": "date-time",
"nullable": true
},
"expires_at": {
"type": "string",
"description": "When the saved price stops being honoured (UTC): its last change plus the branch's quote expiry; null for a quote saved without pricing.",
"format": "date-time",
"nullable": true
},
"attribution": {
"description": "The first-touch marketing attribution captured at creation; null when none was captured.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConnectLeadAttributionResponse"
}
]
},
"pricing": {
"description": "The selections and server-calculated terms the quote was saved with; null when it has none.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConnectQuotePricingResponse"
}
]
},
"created_at": {
"type": "string",
"description": "When the quote was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The later of the quote's last change and its newest contact change (UTC); send it as expected_updated_at on PATCH /quotes/{quote_id}.",
"format": "date-time"
}
}
},
"ConnectQuotePricingResponse": {
"type": "object",
"description": "A saved quote's selections, in the ids GET /quotes/config publishes, and the terms the\nserver calculated for the chosen frequency. price is the per-visit price the customer was\nquoted: the base plus every-visit modifiers and any promotion, the same number the office's lead\nview shows as Recurring. job_rate is the base alone. A promotion is in the price when\npromotion_applied is true; its code is not published. first_visit_minutes is the\nfirst visit's length for one technician, every-visit and first-visit add-on time included: the\nduration_hours (divided by 60) to ask GET /availability for.",
"additionalProperties": false,
"properties": {
"service_type_id": {
"type": "string",
"description": "The service type's id, as GET /quotes/config lists it."
},
"service_type": {
"type": "string",
"description": "The service type's name.",
"maxLength": 200,
"minLength": 0
},
"pricing_model": {
"type": "string",
"description": "How the service type is priced: by_room, by_square_foot or simplified.",
"pattern": "^(by_room|by_square_foot|simplified)$"
},
"frequency_id": {
"type": "string",
"description": "The chosen frequency option's id, as GET /quotes/config lists it."
},
"frequency": {
"type": "string",
"description": "How often the chosen frequency repeats, such as weekly or one_time.",
"pattern": "^(weekly|every_two_weeks|every_three_weeks|every_four_weeks|other_recurring|quarterly|yearly|one_time|unknown)$"
},
"price": {
"type": "number",
"description": "The per-visit price quoted, in the quote's currency_code: the base plus every-visit modifiers and any every-visit promotion.",
"format": "decimal"
},
"estimated_minutes": {
"type": "number",
"description": "The server-calculated visit length in minutes for the chosen frequency, leaving out the first visit's add-on time.",
"format": "double"
},
"first_visit_minutes": {
"type": "number",
"description": "The first visit's length in minutes for one technician, every-visit and first-visit add-on time included; divided by 60, the duration_hours to ask GET /availability for.",
"format": "double"
},
"square_footage": {
"type": "integer",
"description": "The square footage the quote was priced with; null when none was saved.",
"format": "int32",
"nullable": true
},
"rooms": {
"type": "array",
"description": "Every room the price counted, including a default room set to 0.",
"items": {
"$ref": "#/components/schemas/ConnectSavedRoomResponse"
}
},
"answers": {
"type": "array",
"description": "The answers saved to the service type's online pricing questions.",
"items": {
"$ref": "#/components/schemas/ConnectSavedAnswerResponse"
}
},
"modifiers": {
"type": "array",
"description": "The modifiers the quote was priced with; discounts and promotions are not listed here.",
"items": {
"$ref": "#/components/schemas/ConnectSavedModifierResponse"
}
},
"promotion_applied": {
"type": "boolean",
"description": "True when an every-visit promotion is in price; a first-visit promotion reads false."
}
}
},
"ConnectSavedRoomResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"room_id": {
"type": "string",
"description": "The room's id, as GET /quotes/config lists it."
},
"quantity": {
"type": "integer",
"description": "How many of the room the price counted; 0 for a default room set to none.",
"format": "int32"
}
}
},
"ConnectSavedAnswerResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"question_id": {
"type": "string",
"description": "The pricing question's id, as GET /quotes/config lists it."
},
"answer_ids": {
"type": "array",
"description": "The ids of the chosen answers, as GET /quotes/config lists them.",
"items": {
"type": "string"
}
},
"value": {
"type": "number",
"description": "The numeric answer, for a question answered with a number rather than answer_ids.",
"format": "double",
"nullable": true
}
}
},
"ConnectSavedModifierResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"modifier_id": {
"type": "string",
"description": "The modifier's id, as GET /quotes/config lists it."
},
"quantity": {
"type": "integer",
"description": "How many of the modifier the quote was priced with.",
"format": "int32"
}
}
},
"ConnectJobResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The job's id; read it with GET /jobs/{job_id}."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"created_at": {
"type": "string",
"description": "When the job was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The latest change to the job, its team assignments, its pricing or its timesheets (UTC); send it as version on the job move, skip and cancel actions.",
"format": "date-time"
},
"customer_id": {
"type": "string",
"description": "The customer the job is for; read it with GET /customers/{customer_id}."
},
"home_id": {
"type": "string",
"description": "The home the job is at; read it with GET /homes/{home_id}."
},
"service_set_id": {
"type": "string",
"description": "The service set the job belongs to; read it with GET /service-sets/{service_set_id}."
},
"job_date": {
"type": "string",
"description": "The job's branch-local service date.",
"format": "date"
},
"scheduled_start_at": {
"type": "string",
"description": "The scheduled start (UTC); null when none is stored.",
"format": "date-time",
"nullable": true
},
"scheduled_end_at": {
"type": "string",
"description": "The scheduled end (UTC); null when none is stored.",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"description": "The job's status: scheduled, in_progress or completed from its timesheets while pending, otherwise completed, cancelled, bumped, moved, lock_out or skipped.",
"pattern": "^(scheduled|in_progress|completed|cancelled|skipped|moved|lock_out|bumped)$"
},
"status_reason_code": {
"type": "string",
"description": "Reserved; always null in this version.",
"nullable": true
},
"allowed_time_hours": {
"type": "number",
"description": "The job's allowed time per technician in hours (the scheduled window), not total labor hours.",
"format": "double",
"minimum": 0.0
},
"team_ids": {
"type": "array",
"description": "The branch teams assigned to the job, as GET /teams lists them.",
"items": {
"type": "string"
}
},
"expected_amount": {
"type": "number",
"description": "The job's expected price in currency_code: the base fee plus service-set and job rate modifications, excluding tip, tax and payment state.",
"format": "decimal",
"nullable": true
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
}
}
},
"ConnectQuoteBookRequest": {
"type": "object",
"example": {
"expected_updated_at": "2026-10-21T15:04:05+00:00",
"customer_id": "1201",
"home_id": "3402",
"date": "2026-11-02",
"arrival_window_start": "09:00",
"team_id": "14"
},
"additionalProperties": false,
"properties": {
"expected_updated_at": {
"type": "string",
"description": "The quote's updated_at the customer accepted; a revised quote answers 409 version_conflict.",
"format": "date-time",
"nullable": true,
"example": "2026-10-21T15:04:05+00:00"
},
"customer_id": {
"type": "string",
"description": "A customer of this branch, from POST /customers or a customer read.",
"nullable": true,
"example": "1201"
},
"home_id": {
"type": "string",
"description": "One of that customer's homes, from POST /customers/{customer_id}/homes or a home read.",
"nullable": true,
"example": "3402"
},
"date": {
"type": "string",
"description": "The first visit's date, as one slot of GET /availability publishes it. Availability is not held; the slot is checked again here.",
"format": "date",
"nullable": true,
"example": "2026-11-02"
},
"arrival_window_start": {
"type": "string",
"description": "The first visit's start (HH:mm), inside that slot's arrival window, in the branch's local time.",
"nullable": true,
"example": "09:00"
},
"team_id": {
"type": "string",
"description": "The slot's team. Later visits follow the branch's recurring schedule on the same team.",
"nullable": true,
"example": "14"
}
}
},
"ConnectQuotePaymentLinkResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The link's id.",
"maxLength": 100,
"minLength": 1
},
"quote_id": {
"type": "string",
"description": "The quote the link was minted for.",
"maxLength": 100,
"minLength": 1
},
"customer_id": {
"type": "string",
"description": "The customer the card is saved to when the quote is booked; null while it is a prospect's.",
"maxLength": 100,
"minLength": 1,
"nullable": true
},
"url": {
"type": "string",
"description": "The hosted page to send the customer to. Treat it as a secret: anyone holding it can save a card.",
"maxLength": 2048,
"minLength": 1
},
"expires_at": {
"type": "string",
"description": "When the link stops working (UTC).",
"format": "date-time"
},
"status": {
"type": "string",
"description": "pending when minted; saved and expired are reserved for a later read.",
"pattern": "^(pending|saved|expired)$"
}
}
},
"ConnectQuotePaymentLinkCreateRequest": {
"type": "object",
"example": {
"expiry_days": 7
},
"additionalProperties": false,
"properties": {
"expiry_days": {
"type": "integer",
"description": "Days until the link expires, 1–30. The branch's Connect setting (7 days unless MaidCentral configured another) when absent.",
"format": "int32",
"maximum": 30.0,
"minimum": 1.0,
"nullable": true,
"example": 7
}
}
},
"ConnectQuoteCreateRequest": {
"type": "object",
"example": {
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"phone": "5551234567",
"address": {
"line1": "12 Main St",
"line2": null,
"city": "Denver",
"region": "CO",
"postal_code": "80202"
},
"medium": "web",
"source_name": "Google",
"attribution": {
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring",
"utm_term": null,
"utm_content": null,
"gclid": "Cj0KCQ",
"fbclid": null
},
"home": {
"square_footage": 1800,
"stories": null,
"bedrooms": 3,
"full_bathrooms": 2,
"half_bathrooms": null,
"pets": null,
"people": null,
"has_basement": null,
"dirt_level": null
},
"pricing": {
"service_type_id": "12",
"frequency_id": "31",
"square_footage": null,
"rooms": [
{
"room_id": "5",
"quantity": 2
}
],
"answers": [
{
"question_id": "9",
"answer_ids": [
"91"
],
"value": null
}
],
"modifiers": [
{
"modifier_id": "44",
"quantity": 1
}
],
"promo_code": null
}
},
"additionalProperties": false,
"properties": {
"first_name": {
"type": "string",
"maxLength": 60,
"minLength": 0,
"nullable": true,
"example": "Ada"
},
"last_name": {
"type": "string",
"maxLength": 60,
"minLength": 0,
"nullable": true,
"example": "Lovelace"
},
"email": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": "ada@example.com"
},
"phone": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": "5551234567"
},
"address": {
"description": "Optional. A postal code outside the branch's zones is accepted and tagged Out of Service Area.",
"nullable": true,
"example": {
"line1": "12 Main St",
"line2": null,
"city": "Denver",
"region": "CO",
"postal_code": "80202"
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectLeadAddressRequest"
}
]
},
"medium": {
"type": "string",
"description": "How the prospect reached the business; unknown when absent.",
"pattern": "^(web|web_widget|portal|phone|sms|email|unknown)$",
"nullable": true,
"example": "web"
},
"source_name": {
"type": "string",
"description": "One of the branch's customer sources (\"How did you hear about us?\").",
"maxLength": 100,
"minLength": 0,
"nullable": true,
"example": "Google"
},
"attribution": {
"description": "First-touch marketing attribution. Accepted only here; it is never changed afterwards.",
"nullable": true,
"example": {
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring",
"utm_term": null,
"utm_content": null,
"gclid": "Cj0KCQ",
"fbclid": null
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectLeadAttributionRequest"
}
]
},
"home": {
"nullable": true,
"example": {
"square_footage": 1800,
"stories": null,
"bedrooms": 3,
"full_bathrooms": 2,
"half_bathrooms": null,
"pets": null,
"people": null,
"has_basement": null,
"dirt_level": null
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectLeadHomeRequest"
}
]
},
"pricing": {
"description": "Required. The selections the server prices; the response carries the saved terms.",
"nullable": true,
"example": {
"service_type_id": "12",
"frequency_id": "31",
"square_footage": null,
"rooms": [
{
"room_id": "5",
"quantity": 2
}
],
"answers": [
{
"question_id": "9",
"answer_ids": [
"91"
],
"value": null
}
],
"modifiers": [
{
"modifier_id": "44",
"quantity": 1
}
],
"promo_code": null
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectQuotePricingRequest"
}
]
}
}
},
"ConnectQuotePricingRequest": {
"type": "object",
"description": "The selections a quote is priced from, in the shape POST /quotes/calculate takes, plus\nthe frequency the customer chose.",
"additionalProperties": false,
"properties": {
"service_type_id": {
"type": "string",
"description": "A service type from GET /quotes/config.",
"nullable": true
},
"frequency_id": {
"type": "string",
"description": "The chosen frequency, one of the service type's frequencies.",
"nullable": true
},
"square_footage": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rooms": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ConnectQuoteRoomRequest"
}
},
"answers": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ConnectQuoteAnswerRequest"
}
},
"modifiers": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ConnectQuoteModifierRequest"
}
},
"promo_code": {
"type": "string",
"description": "Not stored: a revision that should keep the promotion sends it again.",
"maxLength": 100,
"minLength": 0,
"nullable": true
}
}
},
"ConnectQuoteRoomRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"room_id": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
}
}
},
"ConnectQuoteAnswerRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"question_id": {
"type": "string",
"nullable": true
},
"answer_ids": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"value": {
"type": "number",
"format": "double",
"nullable": true
}
}
},
"ConnectQuoteModifierRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"modifier_id": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
}
}
},
"ConnectQuoteUpdateRequest": {
"type": "object",
"example": {
"expected_updated_at": "2026-10-22T15:04:05+00:00",
"pricing": {
"service_type_id": "12",
"frequency_id": "32",
"square_footage": null,
"rooms": [
{
"room_id": "5",
"quantity": 3
}
],
"answers": [
{
"question_id": "9",
"answer_ids": [
"91"
],
"value": null
}
],
"modifiers": null,
"promo_code": null
}
},
"additionalProperties": false,
"properties": {
"expected_updated_at": {
"type": "string",
"description": "The updated_at this client last read; a newer write answers 409 version_conflict.",
"format": "date-time",
"nullable": true,
"example": "2026-10-22T15:04:05+00:00"
},
"pricing": {
"description": "Required. Priced again at the current configuration. Replaces every saved selection, including every answer to the service type's online pricing questions: one left out is removed. Text answers and answers to questions not offered online stay.",
"nullable": true,
"example": {
"service_type_id": "12",
"frequency_id": "32",
"square_footage": null,
"rooms": [
{
"room_id": "5",
"quantity": 3
}
],
"answers": [
{
"question_id": "9",
"answer_ids": [
"91"
],
"value": null
}
],
"modifiers": null,
"promo_code": null
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectQuotePricingRequest"
}
]
}
}
},
"ConnectLeadPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectLeadResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectSalesListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectLeadDetailRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectQuotePageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectQuoteResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectQuoteListRequest": {
"allOf": [
{
"$ref": "#/components/schemas/ConnectSalesListRequest"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ConnectQuoteDetailRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectOperationsKpisReportResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"generated_at": {
"type": "string",
"description": "When the report was computed (UTC).",
"format": "date-time"
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"data_available": {
"type": "boolean",
"description": "False when the branch has no payroll weeks, in which case metrics is empty and the weeks are null; read it before any number."
},
"week_count": {
"type": "integer",
"description": "How many payroll weeks the KPIs were computed over; 0 when data_available is false.",
"format": "int32"
},
"current_week": {
"description": "The newest payroll week in the window; null when data_available is false.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConnectReportWeekResponse"
}
]
},
"start_week": {
"description": "The oldest payroll week in the window; null when data_available is false.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConnectReportWeekResponse"
}
]
},
"metrics": {
"type": "array",
"description": "The published Operations KPIs; empty when data_available is false.",
"items": {
"$ref": "#/components/schemas/ConnectReportMetricResponse"
}
}
}
},
"ConnectReportWeekResponse": {
"type": "object",
"description": "A payroll week, as the branch's calendar dates.",
"additionalProperties": false,
"properties": {
"start_date": {
"type": "string",
"description": "The week's first day (branch-local calendar date).",
"format": "date"
},
"end_date": {
"type": "string",
"description": "The week's last day (branch-local calendar date).",
"format": "date"
}
}
},
"ConnectReportMetricResponse": {
"type": "object",
"description": "One Operations KPI. value is already rounded to decimal_places.",
"additionalProperties": false,
"properties": {
"key": {
"type": "string",
"description": "The KPI's published key, one of the Operations KPI keys listed in the endpoint description.",
"maxLength": 50,
"minLength": 0
},
"name": {
"type": "string",
"description": "The KPI's display name, as the office report shows it.",
"maxLength": 100,
"minLength": 0
},
"value": {
"type": "number",
"description": "The KPI's value, rounded to decimal_places.",
"format": "double"
},
"unit": {
"type": "string",
"description": "number, currency (in currency_code) or percent, where 12.5 means 12.5%.",
"pattern": "^(number|currency|percent)$"
},
"decimal_places": {
"type": "integer",
"description": "The number of decimal places value is rounded to.",
"format": "int32",
"maximum": 10.0,
"minimum": 0.0
}
}
},
"ConnectOperationsKpisReportRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectWeekInReviewReportResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"generated_at": {
"type": "string",
"description": "When the report was computed (UTC).",
"format": "date-time"
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"data_available": {
"type": "boolean",
"description": "False when the branch has no week with completed statistics on or before as_of_date; the KPI blocks and weeks are then null and the counts are 0 placeholders, not measurements."
},
"week": {
"description": "The selected week: the newest completed payroll week starting on or before as_of_date; null when data_available is false.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConnectReportWeekResponse"
}
]
},
"weeks_compared": {
"type": "integer",
"description": "How many weeks, including the selected one, each KPI's average is taken over.",
"format": "int32"
},
"data_since_date": {
"type": "string",
"description": "The first day of the oldest compared week (branch-local calendar date); null when data_available is false.",
"format": "date",
"nullable": true
},
"revenue": {
"description": "The selected week's revenue in currency_code against the compared weeks' mean; null when data_available is false.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConnectWeekInReviewKpiResponse"
}
]
},
"cleaning_hourly_rate": {
"description": "Revenue divided by job hours, in currency_code, against the compared weeks' mean; null when data_available is false.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConnectWeekInReviewKpiResponse"
}
]
},
"recurring_customer_count": {
"description": "The recurring customer count against the compared weeks' mean; null when data_available is false.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConnectWeekInReviewKpiResponse"
}
]
},
"quality_score": {
"description": "The average scorecard score as the office screen shows it (0 with none) against the compared weeks' mean; null when data_available is false.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConnectWeekInReviewKpiResponse"
}
]
},
"job_count_weekly": {
"type": "integer",
"description": "The selected week's weekly jobs.",
"format": "int32"
},
"job_count_biweekly": {
"type": "integer",
"description": "The selected week's biweekly jobs.",
"format": "int32"
},
"job_count_other_recurring": {
"type": "integer",
"description": "The selected week's other recurring jobs.",
"format": "int32"
},
"job_count_other": {
"type": "integer",
"description": "The selected week's closed completed jobs that are not weekly, biweekly or other recurring.",
"format": "int32"
},
"job_count_closed_completed": {
"type": "integer",
"description": "The selected week's closed completed jobs.",
"format": "int32"
},
"emails_sent": {
"type": "integer",
"description": "Emails sent in the selected week, including quote emails.",
"format": "int32"
},
"texts_sent": {
"type": "integer",
"description": "Texts sent in the selected week, including quote texts.",
"format": "int32"
},
"notifications_sent": {
"type": "integer",
"description": "Notifications sent in the selected week.",
"format": "int32"
},
"scorecards_sent": {
"type": "integer",
"description": "Scorecards sent in the selected week.",
"format": "int32"
},
"total_automations": {
"type": "integer",
"description": "Emails, texts, notifications and scorecards sent in the selected week, together.",
"format": "int32"
},
"revenue_by_week": {
"type": "array",
"description": "Revenue for each compared week, oldest first; empty when data_available is false.",
"items": {
"$ref": "#/components/schemas/ConnectWeekInReviewRevenuePointResponse"
}
}
}
},
"ConnectWeekInReviewKpiResponse": {
"type": "object",
"description": "The selected week's value against the mean of the compared weeks, which include it.",
"additionalProperties": false,
"properties": {
"value": {
"type": "number",
"description": "The selected week's value.",
"format": "double"
},
"average": {
"type": "number",
"description": "The mean over the weeks_compared weeks, including the selected one; 0 when only one week exists.",
"format": "double"
},
"trend": {
"type": "string",
"description": "positive or negative by whether the move against average is good for this KPI, or neutral when there is no move or only one week.",
"pattern": "^(positive|negative|neutral)$"
},
"direction": {
"type": "string",
"description": "up or down for value against average, or none when they are equal or only one week exists.",
"pattern": "^(up|down|none)$"
}
}
},
"ConnectWeekInReviewRevenuePointResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"week_start_date": {
"type": "string",
"description": "The payroll week's first day (branch-local calendar date).",
"format": "date"
},
"revenue": {
"type": "number",
"description": "The week's revenue in currency_code.",
"format": "double"
}
}
},
"ConnectWeekInReviewReportRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectSalesKpisReportResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"generated_at": {
"type": "string",
"description": "When the report was computed (UTC).",
"format": "date-time"
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"date_from": {
"type": "string",
"description": "The range's first day, inclusive (branch-local calendar date), as requested.",
"format": "date"
},
"date_to": {
"type": "string",
"description": "The range's last day, inclusive (branch-local calendar date), as requested.",
"format": "date"
},
"date_basis": {
"type": "string",
"description": "lead_created follows the leads created in the range forward to as_of_date; event counts every activity dated inside the range.",
"pattern": "^(lead_created|event)$"
},
"as_of_date": {
"type": "string",
"description": "The day lead_created leads are followed to (branch-local calendar date), as requested; null when it was not sent.",
"format": "date",
"nullable": true
},
"total_leads": {
"type": "integer",
"description": "Leads created in the range.",
"format": "int32"
},
"quotes_generated": {
"type": "integer",
"description": "Quotes prepared, for the range's leads or, under event, inside the range.",
"format": "int32"
},
"booked_leads": {
"type": "integer",
"description": "Leads that booked.",
"format": "int32"
},
"booked_leads_recurring": {
"type": "integer",
"description": "Leads that booked a recurring service.",
"format": "int32"
},
"booked_leads_one_time": {
"type": "integer",
"description": "Leads that booked a one-time service.",
"format": "int32"
},
"conversion_rate_percent": {
"type": "number",
"description": "booked_leads divided by quotes_generated times 100, to one decimal; 0 with no quotes.",
"format": "decimal"
},
"booked_revenue": {
"type": "number",
"description": "The booked sales' weekly revenue in currency_code: a biweekly rate halved, a monthly rate divided by four, a one-time service at full amount.",
"format": "decimal"
},
"recurring": {
"description": "Recurring sales and losses, with their revenue.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectSalesKpisRevenueResponse"
}
]
},
"one_time": {
"description": "One-time sales and losses, with their revenue.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectSalesKpisRevenueResponse"
}
]
},
"by_source": {
"type": "array",
"description": "The counts split by lead source, highest revenue first.",
"items": {
"$ref": "#/components/schemas/ConnectSalesKpisSourceResponse"
}
}
}
},
"ConnectSalesKpisRevenueResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"sales_count": {
"type": "integer",
"description": "How many sales were booked.",
"format": "int32"
},
"sales_revenue": {
"type": "number",
"description": "The booked sales' weekly revenue in currency_code.",
"format": "decimal"
},
"loss_count": {
"type": "integer",
"description": "How many losses there were.",
"format": "int32"
},
"loss_revenue": {
"type": "number",
"description": "The losses' weekly revenue in currency_code, as a positive amount.",
"format": "decimal"
},
"net_revenue": {
"type": "number",
"description": "sales_revenue minus loss_revenue, in currency_code.",
"format": "decimal"
}
}
},
"ConnectSalesKpisSourceResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"source_name": {
"type": "string",
"description": "The lead source's name, as the branch labels it; null when the leads have none.",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"leads": {
"type": "integer",
"description": "Leads from this source.",
"format": "int32"
},
"quotes": {
"type": "integer",
"description": "Quotes prepared for this source's leads.",
"format": "int32"
},
"booked_leads": {
"type": "integer",
"description": "This source's leads that booked.",
"format": "int32"
},
"sales_recurring": {
"type": "integer",
"description": "This source's recurring sales.",
"format": "int32"
},
"sales_one_time": {
"type": "integer",
"description": "This source's one-time sales.",
"format": "int32"
},
"loss_recurring": {
"type": "integer",
"description": "This source's recurring losses.",
"format": "int32"
},
"loss_one_time": {
"type": "integer",
"description": "This source's one-time losses.",
"format": "int32"
},
"revenue": {
"type": "number",
"description": "This source's booked weekly revenue in currency_code.",
"format": "decimal"
}
}
},
"ConnectSalesKpisReportRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectScheduleEfficiencyReportResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"generated_at": {
"type": "string",
"description": "When the report was computed (UTC).",
"format": "date-time"
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"date": {
"type": "string",
"description": "The branch-local scheduling day the report covers.",
"format": "date"
},
"teams": {
"type": "array",
"description": "One row per team for the day.",
"items": {
"$ref": "#/components/schemas/ConnectScheduleEfficiencyTeamResponse"
}
}
}
},
"ConnectScheduleEfficiencyTeamResponse": {
"type": "object",
"description": "One team's planned day. Distances and minutes are what the recorded route says;\nrouting_evidence says whether there is a current recorded route behind them.",
"additionalProperties": false,
"properties": {
"team_id": {
"type": "string",
"description": "The team's id, as GET /teams returns it."
},
"team_name": {
"type": "string",
"description": "The team's name.",
"maxLength": 100,
"minLength": 0
},
"date": {
"type": "string",
"description": "The branch-local scheduling day this row covers.",
"format": "date"
},
"day_start_time": {
"type": "string",
"description": "The team's day-start time (branch-local HH:mm:ss), from the lead technician's schedule for the day or else the branch's business-hours start; null when absent.",
"format": "time",
"nullable": true
},
"start_time": {
"type": "string",
"description": "The team's planned start time (branch-local HH:mm:ss); null for a team with no planned day.",
"format": "time",
"nullable": true
},
"end_time": {
"type": "string",
"description": "The team's planned end time (branch-local HH:mm:ss); null for a team with no planned day.",
"format": "time",
"nullable": true
},
"efficiency_percent": {
"type": "number",
"description": "Job hours ÷ clock hours as a percentage (0–100).",
"format": "double"
},
"efficiency_target_percent": {
"type": "number",
"description": "The branch's efficiency goal for the day on the same 0–100 scale; null when the branch has no goal.",
"format": "double",
"nullable": true
},
"job_hours": {
"type": "number",
"description": "Total allowed time on the team's jobs, in hours.",
"format": "double"
},
"clock_hours": {
"type": "number",
"description": "The team's scheduled work hours from start to end.",
"format": "double"
},
"revenue": {
"type": "number",
"description": "Total revenue from the team's jobs, in currency_code.",
"format": "decimal"
},
"revenue_per_job_hour": {
"type": "number",
"description": "revenue ÷ job_hours, in currency_code.",
"format": "decimal"
},
"revenue_per_clock_hour": {
"type": "number",
"description": "revenue ÷ clock_hours, in currency_code.",
"format": "decimal"
},
"total_miles": {
"type": "number",
"description": "Recorded route distance across all segments, in miles; read routing_evidence before treating it as a measurement.",
"format": "double"
},
"paid_miles": {
"type": "number",
"description": "Recorded route miles excluding the drives from home to the first stop and from the last stop home.",
"format": "double"
},
"total_drive_minutes": {
"type": "integer",
"description": "Recorded drive time across all segments, in minutes.",
"format": "int32"
},
"paid_drive_minutes": {
"type": "integer",
"description": "Recorded drive minutes excluding the drives from and to home.",
"format": "int32"
},
"optimized_miles": {
"type": "number",
"description": "Distance of the optimized route, in miles; null when no optimized route is recorded.",
"format": "double",
"nullable": true
},
"optimized_drive_minutes": {
"type": "integer",
"description": "Drive time of the optimized route, in minutes; null when no optimized route is recorded.",
"format": "int32",
"nullable": true
},
"miles_savings": {
"type": "number",
"description": "Miles the optimized route saves; negative when the optimized order is longer, null without an optimized route.",
"format": "double",
"nullable": true
},
"drive_minutes_savings": {
"type": "integer",
"description": "Drive minutes the optimized route saves; negative when the optimized order is longer, null without an optimized route.",
"format": "int32",
"nullable": true
},
"optimization_pending": {
"type": "boolean",
"description": "True while a recent schedule change holds the optimized route back."
},
"routing_evidence": {
"type": "string",
"description": "What the distances stand on: recorded, stale, missing or not_routed.",
"pattern": "^(recorded|stale|missing|not_routed)$"
},
"job_count": {
"type": "integer",
"description": "Job stops on the team's route.",
"format": "int32"
},
"stop_count": {
"type": "integer",
"description": "Every stop on the team's route, including start, end and events.",
"format": "int32"
},
"is_disabled": {
"type": "boolean",
"description": "True when the team is disabled."
}
}
},
"ConnectScheduleEfficiencyReportRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectOpenInvoicesReportResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"generated_at": {
"type": "string",
"description": "When the report was computed (UTC).",
"format": "date-time"
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"date_from": {
"type": "string",
"description": "The first invoice date of the requested range, inclusive.",
"format": "date"
},
"date_to": {
"type": "string",
"description": "The last invoice date of the requested range, inclusive.",
"format": "date"
},
"data_available": {
"type": "boolean",
"description": "False when the branch's QuickBooks Online is not connected or is blocked; the report is then empty."
},
"unavailable_reason": {
"type": "string",
"description": "accounting_not_connected or accounting_blocked when data_available is false; otherwise null.",
"pattern": "^(accounting_not_connected|accounting_blocked)$",
"nullable": true
},
"invoice_count": {
"type": "integer",
"description": "The number of invoices in invoices.",
"format": "int32"
},
"total_amount": {
"type": "number",
"description": "The sum of the invoices' totals, in currency_code.",
"format": "decimal"
},
"total_balance": {
"type": "number",
"description": "The sum of the invoices' balances, in currency_code.",
"format": "decimal"
},
"total_overdue": {
"type": "number",
"description": "The sum of the invoices' overdue balances, in currency_code.",
"format": "decimal"
},
"is_truncated": {
"type": "boolean",
"description": "True when the 1,000-invoice read limit was reached; narrow the range."
},
"invoices": {
"type": "array",
"description": "Invoices with a balance dated in the range that have a Pulse job, newest invoice date first.",
"items": {
"$ref": "#/components/schemas/ConnectOpenInvoiceResponse"
}
}
}
},
"ConnectOpenInvoiceResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"invoice_number": {
"type": "string",
"description": "The invoice's number in QuickBooks Online; null when it has none.",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"customer_id": {
"type": "string",
"description": "The customer's id; read it with GET /customers/{customer_id}."
},
"invoice_date": {
"type": "string",
"description": "The invoice's date in QuickBooks Online (a calendar day).",
"format": "date"
},
"due_date": {
"type": "string",
"description": "The invoice's due date (a calendar day); 30 days after invoice_date when QuickBooks Online has none.",
"format": "date"
},
"total": {
"type": "number",
"description": "The invoice total, in currency_code.",
"format": "decimal"
},
"balance": {
"type": "number",
"description": "The amount still owed on the invoice, in currency_code.",
"format": "decimal"
},
"overdue_balance": {
"type": "number",
"description": "The balance when the invoice is overdue, otherwise 0, in currency_code.",
"format": "decimal"
},
"is_overdue": {
"type": "boolean",
"description": "True when due_date is before today in the branch's scheduling zone."
},
"billing_terms": {
"type": "string",
"description": "The customer's billing terms; null when none are set.",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"job_ids": {
"type": "array",
"description": "The invoice's Pulse jobs; read each with GET /jobs/{job_id}.",
"items": {
"type": "string"
}
}
}
},
"ConnectDateRangeReportRequest": {
"type": "object",
"description": "The inclusive date range Open Invoices and Cancelled Customers take.",
"additionalProperties": false
},
"ConnectCancelledCustomersReportResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"generated_at": {
"type": "string",
"description": "When the report was computed (UTC).",
"format": "date-time"
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"date_from": {
"type": "string",
"description": "The first branch-local day of the requested range, inclusive.",
"format": "date"
},
"date_to": {
"type": "string",
"description": "The last branch-local day of the requested range, inclusive.",
"format": "date"
},
"total_cancelled": {
"type": "integer",
"description": "Cancel Service tickets opened in the range.",
"format": "int32"
},
"cancelled_within_60_days": {
"type": "integer",
"description": "Cancellations within 60 days of the first service.",
"format": "int32"
},
"average_tenure_days": {
"type": "number",
"description": "The average tenure_days across the cancellations.",
"format": "decimal"
},
"average_bill_rate": {
"type": "number",
"description": "The average bill rate of the cancelled services, in currency_code.",
"format": "decimal"
},
"by_reason": {
"type": "array",
"description": "Cancellations per reason, split by tenure bucket.",
"items": {
"$ref": "#/components/schemas/ConnectCancellationReasonSummaryResponse"
}
},
"by_team": {
"type": "array",
"description": "Cancellations per default team.",
"items": {
"$ref": "#/components/schemas/ConnectCancellationTeamSummaryResponse"
}
},
"by_tenure": {
"type": "array",
"description": "Cancellations per tenure bucket.",
"items": {
"$ref": "#/components/schemas/ConnectTenureBucketResponse"
}
},
"items": {
"type": "array",
"description": "One row per Cancel Service ticket opened in the range.",
"items": {
"$ref": "#/components/schemas/ConnectCancelledCustomerResponse"
}
}
}
},
"ConnectCancellationReasonSummaryResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"reason": {
"type": "string",
"description": "The cancellation reason.",
"maxLength": 100,
"minLength": 0
},
"under_3_months": {
"type": "integer",
"description": "Cancellations for this reason within 3 months of starting.",
"format": "int32"
},
"months_3_to_6": {
"type": "integer",
"description": "Cancellations for this reason 3–6 months after starting.",
"format": "int32"
},
"months_6_to_12": {
"type": "integer",
"description": "Cancellations for this reason 6–12 months after starting.",
"format": "int32"
},
"years_1_to_2": {
"type": "integer",
"description": "Cancellations for this reason 1–2 years after starting.",
"format": "int32"
},
"years_2_to_5": {
"type": "integer",
"description": "Cancellations for this reason 2–5 years after starting.",
"format": "int32"
},
"over_5_years": {
"type": "integer",
"description": "Cancellations for this reason 5 or more years after starting.",
"format": "int32"
},
"total": {
"type": "integer",
"description": "All cancellations for this reason.",
"format": "int32"
}
}
},
"ConnectCancellationTeamSummaryResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"team_id": {
"type": "string",
"description": "The default team's id, as GET /teams returns it; it can be a holding team."
},
"total": {
"type": "integer",
"description": "Cancellations whose service has this default team.",
"format": "int32"
},
"percent": {
"type": "number",
"description": "This team's share of all cancellations (0–100).",
"format": "decimal"
}
}
},
"ConnectTenureBucketResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"bucket": {
"type": "string",
"description": "The tenure bucket, one of the tenure_bucket values.",
"maxLength": 20,
"minLength": 0
},
"count": {
"type": "integer",
"description": "Cancellations in this bucket.",
"format": "int32"
}
}
},
"ConnectCancelledCustomerResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"customer_id": {
"type": "string",
"description": "The customer's id; read it with GET /customers/{customer_id}."
},
"cancellation_date": {
"type": "string",
"description": "The branch-local day the Cancel Service ticket was opened.",
"format": "date"
},
"client_since": {
"type": "string",
"description": "The day the customer's service started (its first job); null when there is none.",
"format": "date",
"nullable": true
},
"tenure_days": {
"type": "integer",
"description": "Days from the service's first closed job to the cancellation.",
"format": "int32"
},
"tenure_bucket": {
"type": "string",
"description": "tenure_days grouped: < 3 Months, 3-6 Months, 6-12 Months, 1-2 Years, 2-5 Years or 5+ Years.",
"maxLength": 20,
"minLength": 0
},
"cancelled_within_60_days": {
"type": "boolean",
"description": "True when the cancellation came 1–59 days after the first service."
},
"cancellation_reason": {
"type": "string",
"description": "The cancellation reason recorded on the ticket.",
"maxLength": 100,
"minLength": 0
},
"lead_source": {
"type": "string",
"description": "The customer's lead source.",
"maxLength": 100,
"minLength": 0
},
"scope_group": {
"type": "string",
"description": "The service's scope group.",
"maxLength": 100,
"minLength": 0
},
"frequency": {
"type": "string",
"description": "The service's frequency.",
"maxLength": 100,
"minLength": 0
},
"bill_rate": {
"type": "number",
"description": "The service's bill rate at cancellation, in currency_code.",
"format": "decimal"
},
"average_scorecard": {
"type": "number",
"description": "The average scorecard rating on the 1–5 scale; null when there is none.",
"format": "decimal",
"nullable": true
},
"default_team_ids": {
"type": "array",
"description": "The service's default teams' ids, as GET /teams returns them.",
"items": {
"type": "string"
}
}
}
},
"ConnectEmployeeStatsReportResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"generated_at": {
"type": "string",
"description": "When the report was computed (UTC).",
"format": "date-time"
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"date_from": {
"type": "string",
"description": "The first day of the range, inclusive; the start of the last 180 days in the branch's time zone when no range was sent.",
"format": "date"
},
"date_to": {
"type": "string",
"description": "The last day of the range, inclusive; the end of the last 180 days in the branch's time zone when no range was sent.",
"format": "date"
},
"include_terminated": {
"type": "boolean",
"description": "True when technicians whose employment overlapped the range were added (include_terminated)."
},
"technician_count": {
"type": "integer",
"description": "The number of technicians in technicians.",
"format": "int32"
},
"technicians": {
"type": "array",
"description": "One row per technician.",
"items": {
"$ref": "#/components/schemas/ConnectEmployeeStatsResponse"
}
},
"productivity": {
"type": "array",
"description": "Productivity per technician and service type with include_productivity=true; otherwise null.",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ConnectEmployeeProductivityResponse"
}
}
}
},
"ConnectEmployeeStatsResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"technician_id": {
"type": "string",
"description": "The technician's id; read it with GET /technicians/{technician_id}."
},
"first_name": {
"type": "string",
"description": "The technician's first name.",
"maxLength": 100,
"minLength": 0
},
"last_name": {
"type": "string",
"description": "The technician's last name.",
"maxLength": 100,
"minLength": 0
},
"is_terminated": {
"type": "boolean",
"description": "True whenever a termination date is recorded, including a future one."
},
"days_scheduled": {
"type": "integer",
"description": "Days the technician was scheduled in the range.",
"format": "int32"
},
"days_worked": {
"type": "integer",
"description": "Days the technician worked in the range.",
"format": "int32"
},
"days_late": {
"type": "number",
"description": "Days the technician was late in the range.",
"format": "double"
},
"days_absent": {
"type": "integer",
"description": "Unexcused + excused + time-off days; tardies the branch converts to unexcused days are in days_unexcused, not here.",
"format": "int32"
},
"days_unexcused": {
"type": "integer",
"description": "Unexcused absence days, including tardies the branch converts to unexcused days.",
"format": "int32"
},
"days_excused": {
"type": "integer",
"description": "Excused absence days.",
"format": "int32"
},
"days_time_off": {
"type": "integer",
"description": "Time-off days.",
"format": "int32"
},
"attendance_score": {
"type": "number",
"description": "1 − (days_absent + 0.5 × days_late) ÷ days_worked, 0–1; null with no days worked.",
"format": "double",
"nullable": true
},
"jobs": {
"type": "integer",
"description": "The technician's jobs in the range; jobs on open clock-ins and timesheets still count.",
"format": "int32"
},
"job_hours": {
"type": "number",
"description": "The technician's job hours in the range.",
"format": "double"
},
"clock_hours": {
"type": "number",
"description": "The technician's clock hours in the range; open clock-ins and timesheets add none.",
"format": "double"
},
"revenue": {
"type": "number",
"description": "The technician's revenue in the range, in currency_code.",
"format": "double"
},
"efficiency": {
"type": "number",
"description": "job_hours ÷ clock_hours, at most 1; 0 with no clock hours.",
"format": "double"
},
"non_productive_time_factor": {
"type": "number",
"description": "1 − (actual − planned non-productive time) ÷ planned clock time; above 1 used less than planned, null without planned time.",
"format": "decimal",
"nullable": true
},
"scorecards": {
"type": "integer",
"description": "Customer ratings the technician received in the range.",
"format": "int32"
},
"scorecards_5": {
"type": "integer",
"description": "Five-star ratings.",
"format": "int32"
},
"scorecards_4": {
"type": "integer",
"description": "Four-star ratings.",
"format": "int32"
},
"scorecards_3": {
"type": "integer",
"description": "Three-star ratings.",
"format": "int32"
},
"scorecards_2": {
"type": "integer",
"description": "Two-star ratings.",
"format": "int32"
},
"scorecards_1": {
"type": "integer",
"description": "One-star ratings.",
"format": "int32"
},
"scorecard_score": {
"type": "number",
"description": "The average rating on a 0–4 scale (4 = all five stars); null with no ratings.",
"format": "double",
"nullable": true
},
"scorecard_response_rate": {
"type": "number",
"description": "Ratings ÷ jobs.",
"format": "decimal"
}
}
},
"ConnectEmployeeProductivityResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"technician_id": {
"type": "string",
"description": "The technician's id; read it with GET /technicians/{technician_id}."
},
"service_type_id": {
"type": "string",
"description": "The service type's id."
},
"service_type_name": {
"type": "string",
"description": "The service type's name.",
"maxLength": 100,
"minLength": 0
},
"productivity": {
"type": "number",
"description": "Allowed ÷ actual labor hours for this service type; above 1 is faster.",
"format": "double"
},
"job_count": {
"type": "integer",
"description": "The technician's jobs of this service type in the range.",
"format": "int32"
},
"allowed_hours": {
"type": "number",
"description": "The technician's allowed labor hours on those jobs.",
"format": "double"
},
"actual_hours": {
"type": "number",
"description": "The technician's actual labor hours on those jobs.",
"format": "double"
}
}
},
"ConnectEmployeeStatsReportRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectQuoteConfigResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"customer_sources": {
"type": "array",
"description": "The branch's \"How did you hear about us?\" choices to offer online, by name, each name once; source_name on POST /leads and POST /quotes accepts every one.",
"items": {
"type": "string"
}
},
"service_types": {
"type": "array",
"description": "The service types the branch offers for online quoting.",
"items": {
"$ref": "#/components/schemas/ConnectQuoteServiceTypeResponse"
}
}
}
},
"ConnectQuoteServiceTypeResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The service type's id, the service_type_id service sets publish; send it to POST /quotes/calculate."
},
"name": {
"type": "string",
"description": "The service type's name, as the branch set it.",
"maxLength": 200,
"minLength": 0
},
"scope_group_id": {
"type": "string",
"description": "The id of the group the branch filed the service type under; null when it has none.",
"nullable": true
},
"scope_group_name": {
"type": "string",
"description": "The name of the group in scope_group_id; null when it has none.",
"maxLength": 200,
"minLength": 0,
"nullable": true
},
"pricing_model": {
"type": "string",
"description": "How the service type is priced: by_room takes rooms, while by_square_foot and simplified require square_footage.",
"pattern": "^(by_room|by_square_foot|simplified)$"
},
"marketing_text": {
"type": "string",
"description": "The branch's marketing text for the service type; null when none is set.",
"nullable": true
},
"help_text": {
"type": "string",
"description": "The branch's help text for the service type; null when none is set.",
"nullable": true
},
"sort_order": {
"type": "integer",
"description": "The branch's display order; lower first.",
"format": "int32"
},
"frequencies": {
"type": "array",
"description": "The frequencies the service type offers online.",
"items": {
"$ref": "#/components/schemas/ConnectQuoteFrequencyResponse"
}
},
"rooms": {
"type": "array",
"description": "The rooms a customer can choose; empty unless pricing_model is by_room.",
"items": {
"$ref": "#/components/schemas/ConnectQuoteRoomResponse"
}
},
"square_footage_ranges": {
"type": "array",
"description": "The square-footage bands the service type prices, lowest first; empty unless pricing_model is by_square_foot.",
"items": {
"$ref": "#/components/schemas/ConnectQuoteRangeResponse"
}
},
"questions": {
"type": "array",
"description": "The service type's online booking questions.",
"items": {
"$ref": "#/components/schemas/ConnectQuoteQuestionResponse"
}
},
"modifiers": {
"type": "array",
"description": "The modifiers a customer may choose online; promotion codes are never listed.",
"items": {
"$ref": "#/components/schemas/ConnectQuoteModifierResponse"
}
}
}
},
"ConnectQuoteFrequencyResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The frequency's id; send it as frequency_id when saving a quote."
},
"frequency": {
"type": "string",
"description": "The rotation, in the vocabulary service sets publish as frequency.",
"pattern": "^(weekly|every_two_weeks|every_three_weeks|every_four_weeks|other_recurring|quarterly|yearly|one_time|unknown)$"
},
"name": {
"type": "string",
"description": "The frequency's name, as the branch set it.",
"maxLength": 200,
"minLength": 0
},
"ribbon_text": {
"type": "string",
"description": "The branch's ribbon text shown with the frequency; null when none is set.",
"maxLength": 200,
"minLength": 0,
"nullable": true
},
"sort_order": {
"type": "integer",
"description": "The branch's display order; lower first.",
"format": "int32"
},
"bookable": {
"type": "boolean",
"description": "True when POST /quotes/{quote_id}/book can schedule this frequency; when false it can still be priced and saved, but the office books it."
}
}
},
"ConnectQuoteRoomResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The room's id; send it as room_id to POST /quotes/calculate."
},
"name": {
"type": "string",
"description": "The room's name, as the branch set it.",
"maxLength": 200,
"minLength": 0
},
"default_quantity": {
"type": "integer",
"description": "The quantity a form should show by default; pricing counts a default room the request leaves out.",
"format": "int32"
},
"sort_order": {
"type": "integer",
"description": "The branch's display order; lower first.",
"format": "int32"
}
}
},
"ConnectQuoteRangeResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": "number",
"description": "The band's lowest square footage.",
"format": "double"
},
"max": {
"type": "number",
"description": "The band's highest square footage.",
"format": "double"
}
}
},
"ConnectQuoteQuestionResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The question's id; send it as question_id to POST /quotes/calculate."
},
"text": {
"type": "string",
"description": "The question as the branch words it for online customers."
},
"type": {
"type": "string",
"description": "The question's input type; only select_list, multi_select_list, whole_number and decimal questions are answered on POST /quotes/calculate, the rest are for display.",
"pattern": "^(text|select_list|multi_select_list|rich_text|whole_number|decimal|date|time|datetime|other)$"
},
"required": {
"type": "boolean",
"description": "True when POST /quotes/calculate must answer this question (pricing question types only)."
},
"changes_price": {
"type": "boolean",
"description": "True when the branch marked the question's answer as changing the price."
},
"min_value": {
"type": "number",
"description": "The lowest value a numeric answer may take; null when there is no lower bound.",
"format": "double",
"nullable": true
},
"max_value": {
"type": "number",
"description": "The highest value a numeric answer may take; null when there is no upper bound.",
"format": "double",
"nullable": true
},
"help_text": {
"type": "string",
"description": "The branch's help text for the question; null when none is set.",
"nullable": true
},
"sort_order": {
"type": "integer",
"description": "The branch's display order; lower first.",
"format": "int32"
},
"answers": {
"type": "array",
"description": "The choices the question offers; send their ids as answer_ids.",
"items": {
"$ref": "#/components/schemas/ConnectQuoteAnswerResponse"
}
}
}
},
"ConnectQuoteAnswerResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The answer's id; send it in answer_ids to POST /quotes/calculate."
},
"text": {
"type": "string",
"description": "The answer as the branch words it."
},
"min_value": {
"type": "number",
"description": "The lowest value of the range the branch set on this answer; null when none is set.",
"format": "double",
"nullable": true
},
"max_value": {
"type": "number",
"description": "The highest value of the range the branch set on this answer; null when none is set.",
"format": "double",
"nullable": true
},
"sort_order": {
"type": "integer",
"description": "The branch's display order; lower first.",
"format": "int32"
}
}
},
"ConnectQuoteModifierResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The modifier's id; send it as modifier_id to POST /quotes/calculate."
},
"name": {
"type": "string",
"description": "The modifier's name, as the branch set it.",
"maxLength": 200,
"minLength": 0
},
"description": {
"type": "string",
"description": "The branch's description of the modifier; null when none is set.",
"nullable": true
},
"type": {
"type": "string",
"description": "The name of the modifier's type, as the branch's configuration labels it.",
"maxLength": 200,
"minLength": 0
},
"applies_to": {
"type": "string",
"description": "Which visits the modifier is charged on: every_visit or first_visit.",
"pattern": "^(every_visit|first_visit)$"
},
"required": {
"type": "boolean",
"description": "True when the modifier is always applied."
},
"cost": {
"type": "number",
"description": "The modifier's cost: an amount in currency_code when cost_calculation is flat, or a fraction (0.1 is 10%) when it is percentage.",
"format": "decimal"
},
"cost_calculation": {
"type": "string",
"description": "How cost is applied: flat or percentage; a percentage modifier takes quantity 1 only.",
"pattern": "^(flat|percentage)$"
},
"sort_order": {
"type": "integer",
"description": "The branch's display order; lower first.",
"format": "int32"
}
}
},
"ConnectQuoteCalculateResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_type_id": {
"type": "string",
"description": "The service type priced, the id GET /quotes/config publishes for it."
},
"service_type": {
"type": "string",
"description": "The service type's name.",
"maxLength": 200,
"minLength": 0
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"pricing_model": {
"type": "string",
"description": "How the service type is priced: by_room, by_square_foot or simplified.",
"pattern": "^(by_room|by_square_foot|simplified)$"
},
"prices": {
"type": "array",
"description": "The per-visit price for each frequency the service type offers online.",
"items": {
"$ref": "#/components/schemas/ConnectQuotePriceResponse"
}
},
"applied_modifiers": {
"type": "array",
"description": "The modifiers the price includes; first-visit ones are listed here but are not in the per-visit price.",
"items": {
"$ref": "#/components/schemas/ConnectAppliedModifierResponse"
}
},
"promotion_applied": {
"type": "boolean",
"description": "True when promo_code matched a promotion; an unknown or expired code reads false and the prices exclude it."
}
}
},
"ConnectQuotePriceResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"frequency_id": {
"type": "string",
"description": "The frequency's id, the id GET /quotes/config publishes for it."
},
"frequency": {
"type": "string",
"description": "The rotation, in the vocabulary service sets publish as frequency.",
"pattern": "^(weekly|every_two_weeks|every_three_weeks|every_four_weeks|other_recurring|quarterly|yearly|one_time|unknown)$"
},
"name": {
"type": "string",
"description": "The frequency's name, as the branch set it.",
"maxLength": 200,
"minLength": 0
},
"price": {
"type": "number",
"description": "The final per-visit price in currency_code, including every-visit modifiers and any every-visit promotion.",
"format": "decimal"
},
"estimated_minutes": {
"type": "number",
"description": "The visit's estimated length in minutes, as the pricing engine calculates it.",
"format": "double"
},
"minimum_applied": {
"type": "boolean",
"description": "True when the price was raised to the service type's minimum."
},
"ribbon_text": {
"type": "string",
"description": "The branch's ribbon text shown with the frequency; null when none is set.",
"maxLength": 200,
"minLength": 0,
"nullable": true
}
}
},
"ConnectAppliedModifierResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"modifier_id": {
"type": "string",
"description": "The modifier's id, the id GET /quotes/config publishes for it."
},
"name": {
"type": "string",
"description": "The modifier's name, as the branch set it.",
"maxLength": 200,
"minLength": 0
},
"quantity": {
"type": "integer",
"description": "How many of the modifier the price includes.",
"format": "int32"
},
"applies_to": {
"type": "string",
"description": "Which visits the modifier is charged on: every_visit or first_visit; a first-visit modifier is not in the per-visit price.",
"pattern": "^(every_visit|first_visit)$"
}
}
},
"ConnectQuoteCalculateRequest": {
"type": "object",
"example": {
"service_type_id": "12",
"square_footage": null,
"rooms": [
{
"room_id": "5",
"quantity": 2
}
],
"answers": [
{
"question_id": "9",
"answer_ids": [
"91"
],
"value": null
}
],
"modifiers": [
{
"modifier_id": "44",
"quantity": 1
}
],
"promo_code": "SAVE10"
},
"additionalProperties": false,
"properties": {
"service_type_id": {
"type": "string",
"nullable": true,
"example": "12"
},
"square_footage": {
"type": "integer",
"format": "int32",
"nullable": true,
"example": null
},
"rooms": {
"type": "array",
"nullable": true,
"example": [
{
"room_id": "5",
"quantity": 2
}
],
"items": {
"$ref": "#/components/schemas/ConnectQuoteRoomRequest"
}
},
"answers": {
"type": "array",
"nullable": true,
"example": [
{
"question_id": "9",
"answer_ids": [
"91"
],
"value": null
}
],
"items": {
"$ref": "#/components/schemas/ConnectQuoteAnswerRequest"
}
},
"modifiers": {
"type": "array",
"nullable": true,
"example": [
{
"modifier_id": "44",
"quantity": 1
}
],
"items": {
"$ref": "#/components/schemas/ConnectQuoteModifierRequest"
}
},
"promo_code": {
"type": "string",
"nullable": true,
"example": "SAVE10"
}
}
},
"ConnectTeamPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectTeamResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectTeamResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The team's id; pass it as team_id to GET /technicians or in team_ids to GET /availability."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"name": {
"type": "string",
"description": "The team's name; Team {id} when none is stored.",
"maxLength": 100,
"minLength": 0
},
"status": {
"type": "string",
"description": "active unless the team is disabled, then inactive.",
"pattern": "^(active|inactive)$"
},
"sort_order": {
"type": "integer",
"description": "The team's display order in the branch; null when none is set.",
"format": "int32",
"nullable": true
},
"member_count": {
"type": "integer",
"description": "How many of the branch's technicians on the team are active: no termination date, or one still ahead.",
"format": "int32"
},
"created_at": {
"type": "string",
"description": "When the team was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "When the team was last changed (UTC).",
"format": "date-time"
}
}
},
"ConnectOperationsListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectTechnicianPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectTechnicianResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectTechnicianResponse": {
"type": "object",
"description": "Everything a scheduling integration needs about a technician and nothing more. The employee\nrow behind this carries payroll, identity, and home-address data; adding a field here is a\ndeliberate decision, and ConnectOperationsReadTests fails if one appears by accident.",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The technician's id; read it with GET /technicians/{technician_id}."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"display_name": {
"type": "string",
"description": "The technician's first and last name; Technician {id} when blank.",
"maxLength": 200,
"minLength": 0
},
"status": {
"type": "string",
"description": "active when the technician has no termination date or one still ahead; otherwise inactive.",
"pattern": "^(active|inactive)$"
},
"team_id": {
"type": "string",
"description": "The technician's default team, as GET /teams lists it; null when that team is not one the branch owns.",
"nullable": true
},
"skill_ids": {
"type": "array",
"description": "The ids of the skills the technician holds, in ascending order.",
"items": {
"type": "string"
}
}
}
},
"ConnectTechnicianListRequest": {
"allOf": [
{
"$ref": "#/components/schemas/ConnectOperationsListRequest"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ConnectTechnicianDetailRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectZonePageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectZoneResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectZoneResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The zone's id; a home's zone_id, and the zone_id to pass to GET /availability."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"name": {
"type": "string",
"description": "The zone's name; Zone {id} when none is stored.",
"maxLength": 100,
"minLength": 0
},
"postal_codes": {
"type": "array",
"description": "The zone's postal codes in ascending order; empty unless the request set include_zips=true.",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"description": "When the zone was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "When the zone was last changed (UTC).",
"format": "date-time"
}
}
},
"ConnectZoneListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectAvailabilityResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The bookable slots, at most limit of them; availability is not paged.",
"items": {
"$ref": "#/components/schemas/ConnectAvailabilitySlotResponse"
}
}
}
},
"ConnectAvailabilitySlotResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"date": {
"type": "string",
"description": "The slot's day on the branch's scheduling day clock.",
"format": "date"
},
"arrival_window_start": {
"type": "string",
"description": "The earliest time the job may start, on the branch's scheduling day clock.",
"format": "time"
},
"arrival_window_end": {
"type": "string",
"description": "The latest time the job may start, at most two hours after arrival_window_start and equal to it for a single time.",
"format": "time"
},
"team_id": {
"type": "string",
"description": "The team that has the slot, as GET /teams lists it."
},
"team_name": {
"type": "string",
"description": "The team's name; Team {id} when none is stored.",
"maxLength": 100,
"minLength": 0
},
"duration_minutes": {
"type": "integer",
"description": "The visit length the slot was found for: the requested duration_hours in whole minutes.",
"format": "int32"
}
}
},
"ConnectAvailabilityRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectCustomerNoteResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The new note's id; notes are never readable through Pulse Connect.",
"maxLength": 100,
"minLength": 1
},
"customer_id": {
"type": "string",
"description": "The customer the note was added to; read it with GET /customers/{customer_id}.",
"maxLength": 100,
"minLength": 1
},
"created_at": {
"type": "string",
"description": "When the note was added (UTC).",
"format": "date-time"
}
}
},
"ConnectCustomerNoteCreateRequest": {
"type": "object",
"example": {
"text": "Prefers morning visits. Side gate is unlocked."
},
"additionalProperties": false,
"properties": {
"text": {
"type": "string",
"description": "Plain text, 1–5000 characters. Markup is refused.",
"maxLength": 5000,
"minLength": 0,
"nullable": true,
"example": "Prefers morning visits. Side gate is unlocked."
}
}
},
"ConnectQuoteNoteResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The new note's id; notes are never readable through Pulse Connect.",
"maxLength": 100,
"minLength": 1
},
"quote_id": {
"type": "string",
"description": "The quote (or lead) the note was added to; read it with GET /quotes/{quote_id}.",
"maxLength": 100,
"minLength": 1
},
"created_at": {
"type": "string",
"description": "When the note was added (UTC).",
"format": "date-time"
}
}
},
"ConnectQuoteNoteCreateRequest": {
"type": "object",
"example": {
"text": "Asked for a call back after 5pm."
},
"additionalProperties": false,
"properties": {
"text": {
"type": "string",
"description": "Plain text, 1–5000 characters. Markup is refused.",
"maxLength": 5000,
"minLength": 0,
"nullable": true,
"example": "Asked for a call back after 5pm."
}
}
},
"ConnectTechnicianNoteResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The new note's id; notes are never readable through Pulse Connect.",
"maxLength": 100,
"minLength": 1
},
"technician_id": {
"type": "string",
"description": "The technician the note was added to; read it with GET /technicians/{technician_id}.",
"maxLength": 100,
"minLength": 1
},
"created_at": {
"type": "string",
"description": "When the note was added (UTC).",
"format": "date-time"
}
}
},
"ConnectTechnicianNoteCreateRequest": {
"type": "object",
"example": {
"text": "Completed pet-safe products training."
},
"additionalProperties": false,
"properties": {
"text": {
"type": "string",
"description": "Plain text, 1–5000 characters. Markup is refused.",
"maxLength": 5000,
"minLength": 0,
"nullable": true,
"example": "Completed pet-safe products training."
}
}
},
"ConnectJobMoveRequest": {
"type": "object",
"example": {
"version": "2026-10-30T14:12:08.443Z",
"scheduled_start_at": "2026-11-05T09:00",
"reason_id": null,
"notes": "Customer asked for Thursday"
},
"additionalProperties": false,
"required": [
"version",
"scheduled_start_at"
],
"properties": {
"version": {
"type": "string",
"description": "The job's updated_at as last read. A job changed since is refused.",
"minLength": 1,
"example": "2026-10-30T14:12:08.443Z"
},
"scheduled_start_at": {
"type": "string",
"description": "The new start, YYYY-MM-DDTHH:mm on the branch's scheduling day.",
"minLength": 1,
"example": "2026-11-05T09:00"
},
"reason_id": {
"type": "string",
"description": "Optional office reason: one of the branch's move reasons.",
"nullable": true,
"example": null
},
"notes": {
"type": "string",
"description": "Optional note for the office ticket, at most 500 characters.",
"nullable": true,
"example": "Customer asked for Thursday"
}
}
},
"ConnectJobSkipRequest": {
"type": "object",
"example": {
"version": "2026-10-30T14:12:08.443Z",
"charge_fee": false,
"reason_id": null,
"notes": "Customer is away this week"
},
"additionalProperties": false,
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"description": "The job's updated_at as last read. A job changed since is refused.",
"minLength": 1,
"example": "2026-10-30T14:12:08.443Z"
},
"charge_fee": {
"type": "boolean",
"description": "Charge the scope's cancellation fee when the visit is inside its window.",
"example": false
},
"reason_id": {
"type": "string",
"description": "Optional office reason: one of the branch's skip reasons.",
"nullable": true,
"example": null
},
"notes": {
"type": "string",
"description": "Optional note for the office ticket, at most 500 characters.",
"nullable": true,
"example": "Customer is away this week"
}
}
},
"ConnectJobCancelRequest": {
"type": "object",
"example": {
"version": "2026-10-30T14:12:08.443Z",
"notes": "Team unavailable"
},
"additionalProperties": false,
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"description": "The job's updated_at as last read. A job changed since is refused.",
"minLength": 1,
"example": "2026-10-30T14:12:08.443Z"
},
"notes": {
"type": "string",
"description": "Optional note for the office ticket, at most 500 characters.",
"nullable": true,
"example": "Team unavailable"
}
}
},
"ConnectJobPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectJobResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectJobListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectJobDetailRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectCustomerJobListRequest": {
"allOf": [
{
"$ref": "#/components/schemas/ConnectJobListRequest"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ConnectHomePageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectHomeResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectHomeResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The home's id, identifying the customer-home relationship; read it with GET /homes/{home_id}."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"created_at": {
"type": "string",
"description": "When the customer-home relationship was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The latest change to the home's published fields or its address (UTC); send it as expected_updated_at on PATCH /homes/{home_id}.",
"format": "date-time"
},
"customer_id": {
"type": "string",
"description": "The owning customer's id; read it with GET /customers/{customer_id}."
},
"name": {
"type": "string",
"description": "The customer-facing home name; Home {id} when none is stored.",
"maxLength": 100,
"minLength": 0
},
"status": {
"type": "string",
"description": "active when any service set for the home has a future pending job in the branch's timezone; otherwise inactive.",
"pattern": "^(active|inactive)$"
},
"zone_id": {
"type": "string",
"description": "The home's zone, the zone_id to ask GET /availability with for this home; null when the home has no zone in the branch.",
"nullable": true
},
"address": {
"description": "The home's service address.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectAddressResponse"
}
]
}
}
},
"ConnectAddressResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"line1": {
"type": "string",
"description": "The first street line of the service address.",
"maxLength": 50,
"minLength": 0
},
"line2": {
"type": "string",
"description": "The second street line; null when blank.",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"city": {
"type": "string",
"description": "The service address city.",
"maxLength": 50,
"minLength": 0
},
"region": {
"type": "string",
"description": "The service address state, province or region.",
"maxLength": 50,
"minLength": 0
},
"postal_code": {
"type": "string",
"description": "The service address postal code.",
"maxLength": 50,
"minLength": 0
},
"country_code": {
"type": "string",
"description": "The ISO country code (US, CA or GB); null when the stored country cannot be mapped.",
"maxLength": 2,
"minLength": 2,
"nullable": true
}
}
},
"ConnectHomeListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectHomeDetailRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectCustomerHomeListRequest": {
"allOf": [
{
"$ref": "#/components/schemas/ConnectHomeListRequest"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ConnectHomeCreateRequest": {
"type": "object",
"example": {
"name": "Main",
"address": {
"line1": "12 Main St",
"line2": null,
"city": "Denver",
"region": "CO",
"postal_code": "80202",
"country_code": "US"
}
},
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"nullable": true,
"example": "Main"
},
"address": {
"nullable": true,
"example": {
"line1": "12 Main St",
"line2": null,
"city": "Denver",
"region": "CO",
"postal_code": "80202",
"country_code": "US"
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectAddressRequest"
}
]
}
}
},
"ConnectAddressRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"line1": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"line2": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"region": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"postal_code": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"country_code": {
"type": "string",
"description": "US or CA; US when absent.",
"maxLength": 2,
"minLength": 0,
"nullable": true
}
}
},
"ConnectHomeUpdateRequest": {
"type": "object",
"example": {
"expected_updated_at": "2026-10-22T15:04:05+00:00",
"name": null,
"address": {
"line1": "2 Market St",
"line2": "Apt 4",
"city": "Denver",
"region": "CO",
"postal_code": "80202",
"country_code": null
}
},
"additionalProperties": false,
"properties": {
"expected_updated_at": {
"type": "string",
"description": "The updated_at this client last read; a newer write answers 409 version_conflict.",
"format": "date-time",
"nullable": true,
"example": "2026-10-22T15:04:05+00:00"
},
"name": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"nullable": true,
"example": null
},
"address": {
"description": "When present, replaces the whole service address.",
"nullable": true,
"example": {
"line1": "2 Market St",
"line2": "Apt 4",
"city": "Denver",
"region": "CO",
"postal_code": "80202",
"country_code": null
},
"oneOf": [
{
"$ref": "#/components/schemas/ConnectAddressRequest"
}
]
}
}
},
"ConnectCustomerPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectCustomerResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectCustomerResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The customer's id; read it with GET /customers/{customer_id}.",
"maxLength": 100,
"minLength": 1
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id.",
"maxLength": 100,
"minLength": 1
},
"created_at": {
"type": "string",
"description": "When the customer was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The latest change to the customer's published fields or contacts (UTC); send it as expected_updated_at on PATCH /customers/{customer_id}.",
"format": "date-time"
},
"display_name": {
"type": "string",
"description": "The company name when present, otherwise first and last name joined by a space, otherwise Customer {id}.",
"maxLength": 200,
"minLength": 0
},
"first_name": {
"type": "string",
"description": "The customer's first name; null when none is stored.",
"maxLength": 60,
"minLength": 0,
"nullable": true
},
"last_name": {
"type": "string",
"description": "The customer's last name; null when none is stored.",
"maxLength": 60,
"minLength": 0,
"nullable": true
},
"company_name": {
"type": "string",
"description": "The customer's company name; null when none is stored.",
"maxLength": 60,
"minLength": 0,
"nullable": true
},
"status": {
"type": "string",
"description": "The customer's lifecycle status: lead, active_recurring, active_one_time, inactive, closed_lost, or locked, which takes precedence over the others.",
"pattern": "^(lead|active_recurring|active_one_time|inactive|closed_lost|locked)$"
},
"primary_email": {
"type": "string",
"description": "The preferred email when valid, otherwise the first valid listed email; null when there is none.",
"format": "email",
"maxLength": 320,
"minLength": 0,
"nullable": true
},
"primary_phone": {
"type": "string",
"description": "The preferred phone when present, otherwise the first listed phone; null when there is none.",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"contacts": {
"type": "array",
"description": "The customer's non-empty contact values, in the customer's contact order.",
"items": {
"$ref": "#/components/schemas/ConnectCustomerContactResponse"
}
},
"tag_ids": {
"type": "array",
"description": "Ids of the customer's tags, ascending; each is an id GET /tags returns.",
"items": {
"type": "string"
}
},
"consent": {
"description": "The customer's SMS and marketing opt-ins and each channel's opt-out.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectCustomerConsentResponse"
}
]
}
}
},
"ConnectCustomerContactResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The contact's id.",
"maxLength": 100,
"minLength": 1
},
"type": {
"type": "string",
"description": "The contact kind: email, phone or other.",
"pattern": "^(email|phone|other)$"
},
"value": {
"type": "string",
"description": "The stored contact value, trimmed and not normalized.",
"maxLength": 320,
"minLength": 0
},
"is_primary": {
"type": "boolean",
"description": "True for the customer's preferred contact, or for the first listed contact when no valid preference is stored."
}
}
},
"ConnectCustomerConsentResponse": {
"type": "object",
"description": "The customer's consent as separate facts: the SMS (transactional texting) opt-in, the marketing\nopt-in that covers texts and email, and each channel's opt-out. An opt-out stops that channel\nwhatever the opt-ins say.",
"additionalProperties": false,
"properties": {
"sms_opt_in": {
"description": "The customer's opt-in to transactional texts.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectConsentResponse"
}
]
},
"marketing_opt_in": {
"description": "The customer's opt-in to marketing texts and email.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectConsentResponse"
}
]
},
"sms_opt_out": {
"description": "opted_out when any of the customer's phone numbers has unsubscribed from texts.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectConsentResponse"
}
]
},
"email_opt_out": {
"description": "opted_out when any of the customer's email addresses has unsubscribed.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectConsentResponse"
}
]
}
}
},
"ConnectConsentResponse": {
"type": "object",
"description": "One consent fact. updated_at of an opt-out is when the opted-out contact last changed.",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"description": "opted_in, opted_out or not_set.",
"pattern": "^(opted_in|opted_out|not_set)$"
},
"source": {
"type": "string",
"description": "Where an opt-in was recorded; null when none is stored, and always null for an opt-out.",
"maxLength": 100,
"minLength": 0,
"nullable": true
},
"updated_at": {
"type": "string",
"description": "When the fact was recorded (UTC); for an opt-out, when the opted-out contact last changed; null when not set.",
"format": "date-time",
"nullable": true
}
}
},
"ConnectCustomerListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectCustomerLookupResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectCustomerResponse"
}
}
}
},
"ConnectCustomerLookupRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectCustomerRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectTagPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectTagResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectTagResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The tag's id; pass it to POST or DELETE /customers/{customer_id}/tags/{tag_id}."
},
"name": {
"type": "string",
"description": "The tag's name.",
"maxLength": 200,
"minLength": 0
},
"color": {
"type": "string",
"description": "The tag's display color as stored; null when none is set.",
"maxLength": 50,
"minLength": 0,
"nullable": true
},
"active": {
"type": "boolean",
"description": "False when the tag has been deactivated."
},
"created_at": {
"type": "string",
"description": "When the tag was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "When the tag was last changed (UTC).",
"format": "date-time"
}
}
},
"ConnectCustomerCreateRequest": {
"type": "object",
"example": {
"first_name": "Ada",
"last_name": "Lovelace",
"company_name": null,
"email": "ada@example.com",
"phone": "5551234567"
},
"additionalProperties": false,
"properties": {
"first_name": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": "Ada"
},
"last_name": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": "Lovelace"
},
"company_name": {
"type": "string",
"maxLength": 60,
"minLength": 0,
"nullable": true,
"example": null
},
"email": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": "ada@example.com"
},
"phone": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": "5551234567"
}
}
},
"ConnectCustomerUpdateRequest": {
"type": "object",
"example": {
"expected_updated_at": "2026-10-22T15:04:05+00:00",
"first_name": null,
"last_name": null,
"company_name": null,
"email": null,
"phone": "5550000000"
},
"additionalProperties": false,
"properties": {
"expected_updated_at": {
"type": "string",
"description": "The updated_at this client last read; a newer write answers 409 version_conflict.",
"format": "date-time",
"nullable": true,
"example": "2026-10-22T15:04:05+00:00"
},
"first_name": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": null
},
"last_name": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": null
},
"company_name": {
"type": "string",
"description": "An empty string clears the company name.",
"maxLength": 60,
"minLength": 0,
"nullable": true,
"example": null
},
"email": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": null
},
"phone": {
"type": "string",
"maxLength": 50,
"minLength": 0,
"nullable": true,
"example": "5550000000"
}
}
},
"ConnectCustomerConsentRequest": {
"type": "object",
"example": {
"sms_opt_in": true,
"marketing_opt_in": null,
"sms_opt_out": null,
"email_opt_out": null,
"source": "Spring web form"
},
"additionalProperties": false,
"properties": {
"sms_opt_in": {
"type": "boolean",
"description": "true records SMS (texting) consent on the customer's first cell phone; needs source.",
"nullable": true,
"example": true
},
"marketing_opt_in": {
"type": "boolean",
"description": "true records marketing consent (texts and email) on the customer; needs source.",
"nullable": true,
"example": null
},
"sms_opt_out": {
"type": "boolean",
"description": "true unsubscribes every phone number (cell, home, business and any other). An opted-out contact cannot be opted back in through the API.",
"nullable": true,
"example": null
},
"email_opt_out": {
"type": "boolean",
"description": "true unsubscribes every email address. An opted-out contact cannot be opted back in through the API.",
"nullable": true,
"example": null
},
"source": {
"type": "string",
"description": "Where the consent was given, such as a web form; required with an opt-in, added to an opt-out's note.",
"maxLength": 100,
"minLength": 0,
"nullable": true,
"example": "Spring web form"
}
}
},
"ConnectMeResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"credential": {
"description": "The API key this request authenticated with.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectCredentialResponse"
}
]
},
"branch": {
"description": "The branch the key belongs to, as GET /branches returns it.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectBranchResponse"
}
]
},
"scopes": {
"type": "array",
"description": "The public Connect scopes the key was granted.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"actions.execute",
"availability.read",
"billing.read",
"bookings.write",
"customer_notes.write",
"customers.read",
"customers.write",
"homes.read",
"homes.write",
"jobs.change",
"jobs.read",
"leads.read",
"leads.write",
"payments.write",
"pricing.read",
"quote_notes.write",
"quotes.read",
"quotes.write",
"reports.read",
"scorecards.read",
"services.cancel",
"services.read",
"tags.read",
"teams.read",
"technician_notes.write",
"technicians.read",
"time.read",
"usage.read",
"webhooks.manage",
"zones.read"
]
}
},
"contract_version": {
"type": "string",
"description": "The API contract version, connect-v1.",
"pattern": "^connect-v1$",
"enum": [
"connect-v1"
]
}
}
},
"ConnectCredentialResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The API key's id.",
"maxLength": 100,
"minLength": 1
},
"name": {
"type": "string",
"description": "The name the key was given when it was created.",
"maxLength": 200,
"minLength": 0
},
"key_prefix": {
"type": "string",
"description": "The key's leading characters, enough to identify it; the full key is never returned.",
"pattern": "^pc_[A-Za-z0-9_-]{4,16}$"
},
"expires_at": {
"type": "string",
"description": "When the key stops authenticating (UTC).",
"format": "date-time"
}
}
},
"ConnectBranchResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The branch's id; the same value as service_company_id.",
"maxLength": 100,
"minLength": 1
},
"service_company_id": {
"type": "string",
"description": "The branch's id, as every other Connect record carries it in service_company_id.",
"maxLength": 100,
"minLength": 1
},
"created_at": {
"type": "string",
"description": "When the branch was created (UTC).",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "When the branch was last changed (UTC).",
"format": "date-time"
},
"name": {
"type": "string",
"description": "The branch's name.",
"maxLength": 200,
"minLength": 0
},
"status": {
"type": "string",
"description": "active when the branch is operational and enrolled; an inactive branch cannot authenticate a new request.",
"pattern": "^(active|inactive)$",
"enum": [
"active",
"inactive"
]
},
"time_zone": {
"type": "string",
"description": "The branch's IANA time zone; a branch set to Etc/UTC schedules in US Eastern, so its scheduling-day dates and times are Eastern.",
"maxLength": 100,
"minLength": 0
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code, the currency its amounts are in.",
"pattern": "^[A-Z]{3}$"
}
}
},
"ConnectBranchesResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items: the single branch this key belongs to.",
"items": {
"$ref": "#/components/schemas/ConnectBranchResponse"
}
}
}
},
"ConnectCapabilitiesResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id.",
"maxLength": 100,
"minLength": 1
},
"capabilities": {
"description": "Which capability families are on for the branch.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectCapabilities"
}
]
},
"constraints": {
"description": "The branch's limits, such as the maximum page size, the maximum response size and the webhook subscription limit.",
"oneOf": [
{
"$ref": "#/components/schemas/ConnectConstraints"
}
]
},
"webhook_event_types": {
"type": "array",
"description": "The webhook event types a subscription can select; empty while webhooks is false.",
"items": {
"type": "string"
}
}
}
},
"ConnectCapabilities": {
"type": "object",
"additionalProperties": false,
"properties": {
"core_reads": {
"type": "boolean",
"description": "True when the Core family (customer, home, service set, job and scorecard reads) is on for the branch and this release serves it."
},
"reports": {
"type": "boolean",
"description": "True when the Reports family is on for the branch and this release serves it."
},
"webhooks": {
"type": "boolean",
"description": "True when the Webhooks family is on for the branch and this release serves it."
},
"operations": {
"type": "boolean",
"description": "True when the Operations family (teams, technicians, zones, bookable availability) is on for the branch and this release serves it."
},
"billing": {
"type": "boolean",
"description": "True when the Billing family (invoices, payments, balances) is on for the branch and this release serves it."
},
"sales": {
"type": "boolean",
"description": "True when the Sales family (leads, quotes, booking-form configuration, instant pricing) is on for the branch and this release serves it."
},
"time_tracking": {
"type": "boolean",
"description": "True when the Time tracking family (worked-time totals per technician and per job) is on for the branch and this release serves it."
},
"writes": {
"type": "boolean",
"description": "True when the Writes family (customer, home, lead and quote writes, booking, notes, job actions and the service cancel) is on for the branch and this release serves it."
},
"payments": {
"type": "boolean",
"description": "True when the Payments family (minting a save-card payment link) is on for the branch and this release serves it."
},
"actions": {
"type": "boolean",
"description": "True when the Actions family is on for the branch and this release serves it."
}
}
},
"ConnectConstraints": {
"type": "object",
"additionalProperties": false,
"properties": {
"max_monthly_operations": {
"type": "integer",
"description": "The branch's monthly operation allowance, as GET /usage reports it in allowance; 0 when none is set.",
"format": "int32",
"maximum": 2147483647.0,
"minimum": 0.0
},
"max_webhook_subscriptions": {
"type": "integer",
"description": "The branch's webhook subscription limit; -1 means none, and 0 while webhooks is false.",
"format": "int32",
"maximum": 2147483647.0,
"minimum": -1.0
},
"max_page_size": {
"type": "integer",
"description": "The largest page_size a list accepts.",
"format": "int32",
"maximum": 100.0,
"minimum": 100.0,
"enum": [
100
]
},
"max_response_bytes": {
"type": "integer",
"description": "The maximum response size, in bytes.",
"format": "int32",
"maximum": 5242880.0,
"minimum": 5242880.0,
"enum": [
5242880
]
}
}
},
"ConnectInvoicePageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectInvoiceResponse"
}
},
"page": {
"type": "integer",
"description": "The page number returned, starting at 1.",
"format": "int32"
},
"page_size": {
"type": "integer",
"description": "The page size applied.",
"format": "int32"
},
"total_count": {
"type": "integer",
"description": "The total number of the customer's invoices across all pages.",
"format": "int32"
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectInvoiceResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The invoice's id, the key; read it with GET /customers/{customer_id}/invoices/{invoice_id}."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"customer_id": {
"type": "string",
"description": "The customer the invoice bills; read it with GET /customers/{customer_id}."
},
"number": {
"type": "string",
"description": "The invoice number; not unique, as a batched QuickBooks invoice puts one number on several rows.",
"maxLength": 50,
"minLength": 0
},
"status": {
"type": "string",
"description": "open, partially_paid, paid, voided or unknown (a stored value the API does not name yet); overdue is never a status.",
"pattern": "^(open|partially_paid|paid|voided|unknown)$"
},
"subtotal": {
"type": "number",
"description": "The invoice amount before tax, in currency_code.",
"format": "decimal"
},
"tax_total": {
"type": "number",
"description": "The invoice's tax, in currency_code.",
"format": "decimal"
},
"total": {
"type": "number",
"description": "The invoice total, in currency_code.",
"format": "decimal"
},
"amount_paid": {
"type": "number",
"description": "What the invoice no longer owes (total minus balance, including QuickBooks credit memos), in currency_code.",
"format": "decimal"
},
"balance": {
"type": "number",
"description": "What the invoice still owes, in currency_code.",
"format": "decimal"
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"issued_date": {
"type": "string",
"description": "The day the invoice was issued, a branch-local calendar date.",
"format": "date",
"nullable": true
},
"due_date": {
"type": "string",
"description": "The day the invoice is due, a branch-local calendar date; null for every MaidCentral V2 invoice.",
"format": "date",
"nullable": true
},
"paid_date": {
"type": "string",
"description": "When the invoice was paid (UTC); can stay null for a while after a QuickBooks payment reads it as paid.",
"format": "date-time",
"nullable": true
},
"job_ids": {
"type": "array",
"description": "The jobs the invoice bills, each readable with GET /jobs/{job_id}; a MaidCentral V2 invoice lists exactly one.",
"items": {
"type": "string"
}
}
}
},
"ConnectCustomerBillingListRequest": {
"type": "object",
"description": "Billing lists page by number rather than cursor. A page is the de-duplicated union of the\nPulse ledger and the legacy V2 tables, so there is no single ordered key to seek on.",
"additionalProperties": false
},
"ConnectInvoiceDetailRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectPaymentPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectPaymentResponse"
}
},
"page": {
"type": "integer",
"description": "The page number returned, starting at 1.",
"format": "int32"
},
"page_size": {
"type": "integer",
"description": "The page size applied.",
"format": "int32"
},
"total_count": {
"type": "integer",
"description": "The total number of the customer's payments across all pages.",
"format": "int32"
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectPaymentResponse": {
"type": "object",
"description": "Card detail is limited to the brand and the last four, which is what a receipt shows. Nothing\nhere identifies the instrument: no processor transaction id, no authorization code, no cheque\nnumber.",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The payment's id."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"customer_id": {
"type": "string",
"description": "The customer who paid; read it with GET /customers/{customer_id}."
},
"amount": {
"type": "number",
"description": "The amount paid, in currency_code; a partly refunded payment keeps its original amount.",
"format": "decimal"
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"method": {
"type": "string",
"description": "How the payment was made: card, ach, check, cash, credit, wire, other or unknown.",
"pattern": "^(card|ach|check|cash|credit|wire|other|unknown)$"
},
"card_brand": {
"type": "string",
"description": "The card brand for a card payment; null for other methods and for MaidCentral V2 card charges.",
"maxLength": 30,
"minLength": 0,
"nullable": true
},
"card_last_four": {
"type": "string",
"description": "The card's last four digits for a card payment; null for other methods and for MaidCentral V2 card charges.",
"pattern": "^[0-9]{4}$",
"nullable": true
},
"payment_date": {
"type": "string",
"description": "When the payment was made (UTC).",
"format": "date-time"
},
"status": {
"type": "string",
"description": "settled, received (recorded by the business, such as cash or check, and not yet marked settled) or unknown.",
"pattern": "^(settled|received|unknown)$"
},
"invoice_numbers": {
"type": "array",
"description": "The numbers of the invoices the payment settled; empty unless a number identifies exactly one published invoice, so an empty list does not mean it settled nothing.",
"items": {
"type": "string"
}
}
}
},
"ConnectCustomerBillingResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"customer_id": {
"type": "string",
"description": "The customer's id; read it with GET /customers/{customer_id}."
},
"service_company_id": {
"type": "string",
"description": "The branch the record belongs to; the same id GET /branches returns as id."
},
"balance": {
"type": "number",
"description": "The live total the customer owes across their invoices, in currency_code, including invoices not yet published.",
"format": "decimal"
},
"available_credit": {
"type": "number",
"description": "The customer's available credit, in currency_code.",
"format": "decimal"
},
"currency_code": {
"type": "string",
"description": "The branch's ISO 4217 currency code; amounts in this object are in it.",
"pattern": "^[A-Z]{3}$"
},
"open_invoice_count": {
"type": "integer",
"description": "How many of the customer's published invoices have a balance, from stored balances.",
"format": "int32"
},
"overdue_invoice_count": {
"type": "integer",
"description": "How many of the customer's published invoices have a balance and a due_date (or issued_date when it has none) before today on the branch's day.",
"format": "int32"
},
"last_payment_date": {
"type": "string",
"description": "When the customer's latest payment was made (UTC); null when they have none.",
"format": "date-time",
"nullable": true
},
"last_payment_amount": {
"type": "number",
"description": "The customer's latest payment amount, in currency_code; null when they have none.",
"format": "decimal",
"nullable": true
}
}
},
"ConnectCustomerBillingRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectInvoiceCursorPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectInvoiceResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectBranchBillingListRequest": {
"type": "object",
"additionalProperties": false
},
"ConnectPaymentCursorPageResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "The returned items.",
"items": {
"$ref": "#/components/schemas/ConnectPaymentResponse"
}
},
"next_cursor": {
"type": "string",
"description": "Pass as cursor to read the next page; null on the last page.",
"nullable": true
},
"has_more": {
"type": "boolean",
"description": "True when another page follows this one."
}
}
},
"ConnectCustomerCreatedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"customer.created"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"customer"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"required": [
"source"
],
"properties": {
"source": {
"type": "string",
"enum": [
"manual",
"quick_book",
"lead_conversion",
"connect_api",
"online_quote",
"unknown"
]
}
}
}
}
},
"ConnectCustomerStatusChangedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"customer.status_changed"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"customer"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"properties": {
"previous_status": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
}
}
}
}
},
"ConnectJobScheduledEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"job.scheduled"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"job"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"properties": {
"scheduled_date": {
"type": "string",
"format": "date",
"nullable": true
},
"scheduled_start_time": {
"type": "string",
"nullable": true
}
}
}
}
},
"ConnectJobStartedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"job.started"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"job"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"properties": {
"started_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
}
},
"ConnectJobCompletedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"job.completed"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"job"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"properties": {
"completed_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
}
},
"ConnectJobCancelledEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"job.cancelled"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"job"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"required": [
"reason"
],
"properties": {
"cancelled_date": {
"type": "string",
"format": "date",
"nullable": true
},
"reason": {
"type": "string",
"enum": [
"cancelled",
"skipped",
"lock_out",
"bumped"
]
}
}
}
}
},
"ConnectJobRescheduledEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"job.rescheduled"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"job"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"properties": {
"previous_scheduled_date": {
"type": "string",
"format": "date",
"nullable": true
},
"scheduled_date": {
"type": "string",
"format": "date",
"nullable": true
}
}
}
}
},
"ConnectServiceCancelledEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"service.cancelled"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"service"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"properties": {
"effective_date": {
"type": "string",
"format": "date",
"nullable": true
}
}
}
}
},
"ConnectLeadCreatedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"lead.created"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"lead"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false
}
}
},
"ConnectLeadConvertedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"lead.converted"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"lead"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"required": [
"customer_id",
"service_set_id",
"first_job_id",
"first_job_date",
"booked_amount"
],
"properties": {
"customer_id": {
"type": "string",
"nullable": true
},
"service_set_id": {
"type": "string",
"nullable": true
},
"first_job_id": {
"type": "string",
"nullable": true
},
"first_job_date": {
"type": "string",
"format": "date",
"nullable": true
},
"booked_amount": {
"type": "number",
"nullable": true
}
}
}
}
},
"ConnectLeadClosedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"lead.closed"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"lead"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false
}
}
},
"ConnectQuoteRevisedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"quote.revised"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"quote"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"required": [
"revised_total"
],
"properties": {
"revised_total": {
"type": "number",
"nullable": true
}
}
}
}
},
"ConnectPaymentMethodSavedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"payment_method.saved"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"payment_link"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"required": [
"quote_id",
"customer_id"
],
"properties": {
"quote_id": {
"type": "string",
"nullable": true
},
"customer_id": {
"type": "string",
"nullable": true
}
}
}
}
},
"ConnectJobOnTheWayEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"job.on_the_way"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"job"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"required": [
"customer_id",
"scheduled_date"
],
"properties": {
"customer_id": {
"type": "string",
"nullable": true
},
"scheduled_date": {
"type": "string",
"format": "date",
"nullable": true
}
}
}
}
},
"ConnectScorecardSubmittedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"scorecard.submitted"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"scorecard"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"required": [
"job_id",
"customer_id",
"rating"
],
"properties": {
"job_id": {
"type": "string",
"nullable": true
},
"customer_id": {
"type": "string",
"nullable": true
},
"rating": {
"type": "integer",
"nullable": true
}
}
}
}
},
"ConnectInvoiceCreatedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"invoice.created"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"invoice"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"required": [
"customer_id",
"total"
],
"properties": {
"customer_id": {
"type": "string",
"nullable": true
},
"total": {
"type": "number",
"nullable": true
}
}
}
}
},
"ConnectInvoicePaidEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"invoice.paid"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"invoice"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"required": [
"customer_id",
"total"
],
"properties": {
"customer_id": {
"type": "string",
"nullable": true
},
"total": {
"type": "number",
"nullable": true
}
}
}
}
},
"ConnectPaymentReceivedEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"payment.received"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"payment"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false,
"required": [
"customer_id",
"amount"
],
"properties": {
"customer_id": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"nullable": true
}
}
}
}
},
"ConnectTestEvent": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"version",
"occurred_at",
"service_company_id",
"resource",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "The event id; the same on every retry, so deduplicate on it.",
"pattern": "^evt_[0-9a-f]{32}$"
},
"type": {
"type": "string",
"description": "The event type.",
"enum": [
"connect.test"
]
},
"version": {
"type": "integer",
"description": "The payload version.",
"enum": [
1
]
},
"occurred_at": {
"type": "string",
"description": "When the change happened (UTC).",
"format": "date-time"
},
"service_company_id": {
"type": "string",
"description": "The branch the event belongs to; the same id GET /branches returns as id."
},
"resource": {
"type": "object",
"description": "The record the event is about; read it with the GET operation the event's description names.",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"webhook"
]
},
"id": {
"type": "string"
}
}
},
"data": {
"type": "object",
"description": "Event-specific fields, listed below.",
"additionalProperties": false
}
}
}
},
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"description": "Your Pulse Connect API key (starts with pc_), sent on every request.",
"name": "X-API-Key",
"in": "header"
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
{
"name": "Context",
"description": "Who this key is, which branch it reads, and what the branch has turned on. Free; no usage counted."
},
{
"name": "Customers",
"description": "Find, export, create and update customers, and append customer notes."
},
{
"name": "Homes",
"description": "The service addresses customers own: list, read, add and update."
},
{
"name": "Service sets",
"description": "A customer's recurring or one-time service at a home: type, frequency, price and status."
},
{
"name": "Jobs",
"description": "Scheduled visits, and the actions an integration may take on one: move, skip or cancel."
},
{
"name": "Scorecards",
"description": "Customer ratings of completed visits, for review requests and service follow-up. Read-only."
},
{
"name": "Operations",
"description": "Teams, technicians, zones and open availability, plus technician notes."
},
{
"name": "Sales",
"description": "Leads and quotes: capture, read, save and revise, book a saved quote, mint a save-card link."
},
{
"name": "Quoting",
"description": "The branch's booking configuration, and instant prices for a home with no side effects."
},
{
"name": "Billing",
"description": "Invoices, payments and customer balances. Read-only."
},
{
"name": "Reports",
"description": "The branch's KPI and operational reports, computed on request."
},
{
"name": "Time",
"description": "Daily and per-job time summaries for the branch's technicians."
},
{
"name": "Usage",
"description": "The branch's monthly allowance, what it has used, and when it resets."
},
{
"name": "Webhooks",
"description": "Subscribe a URL to events, rotate its signing secret, send a test, and read delivery history."
},
{
"name": "Webhook events",
"description": "The requests Pulse sends to your subscribed URL, one per event type."
}
],
"x-webhooks": {
"customer.created": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A customer was created",
"description": "resource.id is the customer id; read it with GET /customers/{customer_id}. data.source says how the customer was created; unknown when Pulse did not record it, so treat any value you don't recognise as unknown.",
"operationId": "webhook_customer_created",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerCreatedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"customer.status_changed": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A customer's status changed",
"description": "resource.id is the customer id. data carries the previous and the new status.",
"operationId": "webhook_customer_status_changed",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectCustomerStatusChangedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"job.scheduled": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A job was scheduled",
"description": "resource.id is the job id; read it with GET /jobs/{job_id}. A reschedule that replaces a job also sends this for the new job.",
"operationId": "webhook_job_scheduled",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobScheduledEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"job.started": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A job was started",
"description": "resource.id is the job id.",
"operationId": "webhook_job_started",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobStartedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"job.completed": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A job was completed",
"description": "resource.id is the job id.",
"operationId": "webhook_job_completed",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobCompletedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"job.cancelled": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A job was cancelled, skipped, locked out or bumped",
"description": "resource.id is the job id. data.reason says why: \"cancelled\", \"skipped\", \"lock_out\" (the team could not get in) or \"bumped\" (the job was bumped in place, keeping its date).",
"operationId": "webhook_job_cancelled",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobCancelledEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"job.rescheduled": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A job was rescheduled",
"description": "resource.id is the job id. Sent once per reschedule, including a bump that replaced the job or changed its date, never also as a cancel plus a schedule.",
"operationId": "webhook_job_rescheduled",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobRescheduledEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"service.cancelled": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A recurring service was cancelled",
"description": "resource.id is the service set id; read it with GET /service-sets/{service_set_id}.",
"operationId": "webhook_service_cancelled",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectServiceCancelledEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"lead.created": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A lead was captured in Pulse",
"description": "resource.id is the lead id that GET /leads returns, and data is empty. Leads created outside Pulse, including by a data import, do not fire it.",
"operationId": "webhook_lead_created",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadCreatedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"lead.converted": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A lead was booked",
"description": "resource.id is the lead id. booked_amount is the new service's per-visit price at booking in the branch's currency, null when the service has no price. Subscribing needs quotes.read.",
"operationId": "webhook_lead_converted",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadConvertedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"lead.closed": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A lead was closed as lost",
"description": "resource.id is the lead id that GET /leads/{lead_id} returns, and data is empty. Fires when the office or an integration closes a lead in Pulse; read closed_reason from the lead.",
"operationId": "webhook_lead_closed",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLeadClosedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"quote.revised": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A saved quote was re-priced",
"description": "resource.id is the quote id. revised_total is null for an office edit; re-read the quote for current pricing. Delivered at least once per revision, so deduplicate on the event id.",
"operationId": "webhook_quote_revised",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectQuoteRevisedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"payment_method.saved": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A customer saved a card on your payment link",
"description": "Sent only for links your own key minted, and only to subscriptions that key owns. resource.id is the link id. It never carries card details.",
"operationId": "webhook_payment_method_saved",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectPaymentMethodSavedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"job.on_the_way": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A job was marked on the way",
"description": "resource.id is the job id. Fires even when no message goes out: a contact normally gets the on-the-way message once per job, and an updated arrival notice from the office goes to every contact again. A second tap while a send for the same job is in progress fires nothing.",
"operationId": "webhook_job_on_the_way",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectJobOnTheWayEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"scorecard.submitted": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A customer rated a visit",
"description": "resource.id is the scorecard id that GET /scorecards lists. data.rating is 1 to 5. Comments are never sent. Ratings recorded in V2 do not fire it. Subscribing needs scorecards.read.",
"operationId": "webhook_scorecard_submitted",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectScorecardSubmittedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"invoice.created": {
"post": {
"tags": [
"Webhook events"
],
"summary": "An invoice was created in Pulse",
"description": "resource.id is the invoice id; read it with GET /customers/{customer_id}/invoices/{invoice_id}. Invoices created in V2 or by a data import do not send it.",
"operationId": "webhook_invoice_created",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectInvoiceCreatedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"invoice.paid": {
"post": {
"tags": [
"Webhook events"
],
"summary": "An invoice was paid in full",
"description": "resource.id is the invoice id. Sent when a payment or credit recorded in Pulse pays the balance; a payment recorded directly in QuickBooks or V2 does not send it.",
"operationId": "webhook_invoice_paid",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectInvoicePaidEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"payment.received": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A payment was received",
"description": "resource.id is the payment id GET /payments returns. A card or bank charge and a recorded cash, check or other payment each send it, once. It never carries card details.",
"operationId": "webhook_payment_received",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectPaymentReceivedEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
},
"connect.test": {
"post": {
"tags": [
"Webhook events"
],
"summary": "A test delivery",
"description": "Queued by POST /webhooks/{webhook_id}/test. resource.type is \"webhook\" and data is empty.",
"operationId": "webhook_connect_test",
"security": [],
"parameters": [
{
"name": "Pulse-Connect-Event-Id",
"in": "header",
"required": true,
"description": "Stable across every retry of the same event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Delivery-Id",
"in": "header",
"required": true,
"description": "One subscription's copy of that event.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Attempt",
"in": "header",
"required": true,
"description": "1-based attempt number.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Timestamp",
"in": "header",
"required": true,
"description": "Unix seconds, part of the signed value.",
"schema": {
"type": "string"
}
},
{
"name": "Pulse-Connect-Signature",
"in": "header",
"required": true,
"description": "`v1=`, or two comma-separated values during a secret rotation.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectTestEvent"
}
}
}
},
"responses": {
"2XX": {
"description": "Acknowledged; any 2xx stops retries."
}
}
}
}
}
}