{ "openapi": "3.1.0", "info": { "title": "careCycle Public API", "version": "1.0.0" }, "paths": { "/v2/routing-groups/{id}": { "get": { "operationId": "GetV2RoutingGroupsId", "summary": "Get routing group", "description": "Look up one routing group by its ID. The response keeps the older transferConfig field names.", "tags": [ "Routing Groups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Transfer config ID", "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/routing-groups/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdPositiveResponse" } } } }, "400": { "description": "GET /v2/routing-groups/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/routing-groups/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/routing-groups/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/routing-groups/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/routing-groups/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/routing-groups/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/routing-groups/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/routing-groups/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/routing-groups/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/routing-groups/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2RoutingGroupsId", "summary": "Update routing group", "description": "Change a routing group's settings. Fields keep the older transferConfig names.", "tags": [ "Routing Groups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Transfer config ID", "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdParameterId" } } ], "requestBody": { "description": "PATCH /v2/routing-groups/:id Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/routing-groups/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/routing-groups/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/routing-groups/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/routing-groups/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/routing-groups/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/routing-groups/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/routing-groups/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/routing-groups/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/routing-groups/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/routing-groups/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/routing-groups/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2RoutingGroupsIdNegativeResponse503" } } } } } }, "delete": { "operationId": "DeleteV2RoutingGroupsId", "summary": "Delete routing group", "description": "Remove a routing group from your organization.", "tags": [ "Routing Groups" ], "parameters": [ { "name": "expectedUpdatedAt", "in": "query", "required": false, "description": "DELETE /v2/routing-groups/:id Parameter", "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdParameterExpectedUpdatedAt" } }, { "name": "id", "in": "path", "required": true, "description": "Transfer config ID", "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/routing-groups/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/routing-groups/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/routing-groups/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/routing-groups/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/routing-groups/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/routing-groups/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/routing-groups/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/routing-groups/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/routing-groups/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/routing-groups/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/routing-groups/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2RoutingGroupsIdNegativeResponse503" } } } } } } }, "/v2/routing-groups": { "get": { "operationId": "GetV2RoutingGroups", "summary": "List routing groups", "description": "List your routing groups. A routing group decides who gets a call when the AI transfers it. Fields keep the older transferConfig names.", "tags": [ "Routing Groups" ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/routing-groups Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsPositiveResponse" } } } }, "400": { "description": "GET /v2/routing-groups Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsNegativeResponse400" } } } }, "401": { "description": "GET /v2/routing-groups Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsNegativeResponse401" } } } }, "403": { "description": "GET /v2/routing-groups Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsNegativeResponse403" } } } }, "404": { "description": "GET /v2/routing-groups Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsNegativeResponse404" } } } }, "409": { "description": "GET /v2/routing-groups Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsNegativeResponse409" } } } }, "422": { "description": "GET /v2/routing-groups Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsNegativeResponse422" } } } }, "429": { "description": "GET /v2/routing-groups Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsNegativeResponse429" } } } }, "500": { "description": "GET /v2/routing-groups Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsNegativeResponse500" } } } }, "502": { "description": "GET /v2/routing-groups Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsNegativeResponse502" } } } }, "503": { "description": "GET /v2/routing-groups Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2RoutingGroupsNegativeResponse503" } } } } } }, "post": { "operationId": "PostV2RoutingGroups", "summary": "Create routing group", "description": "Create a routing group to decide who gets a call when the AI transfers it. The types are Direct, Dynamic, SIP, and Softphone. Fields keep the older transferConfig names.", "tags": [ "Routing Groups" ], "requestBody": { "description": "POST /v2/routing-groups Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/routing-groups Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsPositiveResponse" } } } }, "400": { "description": "POST /v2/routing-groups Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsNegativeResponse400" } } } }, "401": { "description": "POST /v2/routing-groups Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsNegativeResponse401" } } } }, "403": { "description": "POST /v2/routing-groups Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsNegativeResponse403" } } } }, "404": { "description": "POST /v2/routing-groups Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsNegativeResponse404" } } } }, "409": { "description": "POST /v2/routing-groups Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsNegativeResponse409" } } } }, "422": { "description": "POST /v2/routing-groups Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsNegativeResponse422" } } } }, "429": { "description": "POST /v2/routing-groups Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsNegativeResponse429" } } } }, "500": { "description": "POST /v2/routing-groups Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsNegativeResponse500" } } } }, "502": { "description": "POST /v2/routing-groups Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsNegativeResponse502" } } } }, "503": { "description": "POST /v2/routing-groups Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2RoutingGroupsNegativeResponse503" } } } } } } }, "/v2/calendars/{id}": { "get": { "operationId": "GetV2CalendarsId", "summary": "Get calendar", "description": "Look up one booking calendar by its ID. The response keeps the older appointmentConfig field names.", "tags": [ "Calendars" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Calendar ID", "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calendars/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdPositiveResponse" } } } }, "400": { "description": "GET /v2/calendars/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/calendars/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/calendars/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/calendars/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/calendars/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/calendars/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/calendars/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/calendars/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/calendars/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/calendars/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2CalendarsId", "summary": "Update calendar", "description": "Change a booking calendar's settings. Fields keep the older appointmentConfig names.", "tags": [ "Calendars" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Calendar ID", "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdParameterId" } } ], "requestBody": { "description": "PATCH /v2/calendars/:id Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/calendars/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/calendars/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/calendars/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/calendars/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/calendars/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/calendars/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/calendars/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/calendars/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/calendars/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/calendars/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/calendars/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CalendarsIdNegativeResponse503" } } } } } }, "delete": { "operationId": "DeleteV2CalendarsId", "summary": "Delete calendar", "description": "Remove a booking calendar. If a campaign still uses it, take it off that campaign first.", "tags": [ "Calendars" ], "parameters": [ { "name": "expectedUpdatedAt", "in": "query", "required": false, "description": "DELETE /v2/calendars/:id Parameter", "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdParameterExpectedUpdatedAt" } }, { "name": "id", "in": "path", "required": true, "description": "Calendar ID", "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/calendars/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/calendars/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/calendars/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/calendars/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/calendars/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/calendars/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/calendars/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/calendars/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/calendars/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/calendars/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/calendars/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CalendarsIdNegativeResponse503" } } } } } } }, "/v2/calendars": { "get": { "operationId": "GetV2Calendars", "summary": "List calendars", "description": "List your booking calendars. A booking calendar sets when appointments can be booked and who they go to. Fields keep the older appointmentConfig names.", "tags": [ "Calendars" ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calendars Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsPositiveResponse" } } } }, "400": { "description": "GET /v2/calendars Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsNegativeResponse400" } } } }, "401": { "description": "GET /v2/calendars Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsNegativeResponse401" } } } }, "403": { "description": "GET /v2/calendars Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsNegativeResponse403" } } } }, "404": { "description": "GET /v2/calendars Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsNegativeResponse404" } } } }, "409": { "description": "GET /v2/calendars Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsNegativeResponse409" } } } }, "422": { "description": "GET /v2/calendars Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsNegativeResponse422" } } } }, "429": { "description": "GET /v2/calendars Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsNegativeResponse429" } } } }, "500": { "description": "GET /v2/calendars Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsNegativeResponse500" } } } }, "502": { "description": "GET /v2/calendars Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsNegativeResponse502" } } } }, "503": { "description": "GET /v2/calendars Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CalendarsNegativeResponse503" } } } } } }, "post": { "operationId": "PostV2Calendars", "summary": "Create calendar", "description": "Create a booking calendar that sets when appointments can be booked and who they go to. Fields keep the older appointmentConfig names.", "tags": [ "Calendars" ], "requestBody": { "description": "POST /v2/calendars Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/calendars Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsPositiveResponse" } } } }, "400": { "description": "POST /v2/calendars Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsNegativeResponse400" } } } }, "401": { "description": "POST /v2/calendars Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsNegativeResponse401" } } } }, "403": { "description": "POST /v2/calendars Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsNegativeResponse403" } } } }, "404": { "description": "POST /v2/calendars Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsNegativeResponse404" } } } }, "409": { "description": "POST /v2/calendars Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsNegativeResponse409" } } } }, "422": { "description": "POST /v2/calendars Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsNegativeResponse422" } } } }, "429": { "description": "POST /v2/calendars Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsNegativeResponse429" } } } }, "500": { "description": "POST /v2/calendars Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsNegativeResponse500" } } } }, "502": { "description": "POST /v2/calendars Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsNegativeResponse502" } } } }, "503": { "description": "POST /v2/calendars Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CalendarsNegativeResponse503" } } } } } } }, "/v2/phone-suppressions/suppress/{id}": { "get": { "operationId": "getSuppressionRequestStatus", "summary": "Get suppression request status", "description": "Check whether a request to block phone numbers has finished. Use the jobId you got back from Suppress phone numbers. Returns queued, active, completed, or failed, with counts and row errors when available. Requires phone_suppression.manage and the same organization and user that submitted the request. This is an operation status, not a lookup of a number's current suppression state.", "tags": [ "Phone Suppressions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v2/phone-suppressions/suppress/:id Parameter", "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/phone-suppressions/suppress/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdPositiveResponse" } } } }, "400": { "description": "GET /v2/phone-suppressions/suppress/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/phone-suppressions/suppress/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/phone-suppressions/suppress/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/phone-suppressions/suppress/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/phone-suppressions/suppress/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/phone-suppressions/suppress/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/phone-suppressions/suppress/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/phone-suppressions/suppress/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/phone-suppressions/suppress/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/phone-suppressions/suppress/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2PhoneSuppressionsSuppressIdNegativeResponse503" } } } } } } }, "/v2/phone-suppressions/suppress": { "post": { "operationId": "suppressPhoneNumbers", "summary": "Suppress phone numbers", "description": "Block phone numbers so careCycle never contacts them and they can't call in. The block applies to your whole organization.\n\nSend a body containing only `records`. The server generates the operation identity and returns a `jobId`. No client-generated key is required. An optional `Idempotency-Key` header (1 to 200 characters) lets you reuse the same operation when retrying with the same records, including after a lost response. Reusing a supplied key with different records returns 409. Without the header, each submission creates a new operation. Poll `GET /v2/phone-suppressions/suppress/{jobId}` with the same caller credentials to obtain progress and the final outcome; it requires `phone_suppression.manage` with the standard View prerequisite.\n\nSubmit one or more phone numbers in the `records` array, up to 1,000 per request. Each record contains `phoneNumber` and an optional `reason`. Formatting is normalized automatically; blank or unrecognized reasons become `other`. Duplicate numbers use the first record. Requires `phone_suppression.manage`. The response acknowledges records accepted for processing.\n\nSingle record:\n```json\n{\n \"records\": [\n {\n \"phoneNumber\": \"2125550123\",\n \"reason\": \"customer_request\"\n }\n ]\n}\n```\n\nMultiple records:\n```json\n{\n \"records\": [\n {\n \"phoneNumber\": \"2125550123\",\n \"reason\": \"customer_request\"\n },\n {\n \"phoneNumber\": \"+1 (212) 555-0124\",\n \"reason\": \"other\"\n }\n ]\n}\n```", "tags": [ "Phone Suppressions" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Optional retry key. Omit it to let the server create a new operation. When supplied, reuse it with the same records for retries; use a new key for a new operation.", "schema": { "type": "string", "minLength": 1, "maxLength": 200 } } ], "requestBody": { "description": "POST /v2/phone-suppressions/suppress Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/phone-suppressions/suppress Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressPositiveResponse" } } } }, "400": { "description": "POST /v2/phone-suppressions/suppress Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressNegativeResponse400" } } } }, "401": { "description": "POST /v2/phone-suppressions/suppress Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressNegativeResponse401" } } } }, "403": { "description": "POST /v2/phone-suppressions/suppress Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressNegativeResponse403" } } } }, "404": { "description": "POST /v2/phone-suppressions/suppress Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressNegativeResponse404" } } } }, "409": { "description": "Idempotency-Key was already used with different records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressNegativeResponse400" } } } }, "422": { "description": "POST /v2/phone-suppressions/suppress Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressNegativeResponse422" } } } }, "429": { "description": "POST /v2/phone-suppressions/suppress Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressNegativeResponse429" } } } }, "500": { "description": "POST /v2/phone-suppressions/suppress Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressNegativeResponse500" } } } }, "502": { "description": "POST /v2/phone-suppressions/suppress Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressNegativeResponse502" } } } }, "503": { "description": "POST /v2/phone-suppressions/suppress Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PhoneSuppressionsSuppressNegativeResponse503" } } } } } } }, "/v2/appointments/{id}/events": { "get": { "operationId": "GetV2AppointmentsIdEvents", "summary": "List the audit history for an appointment", "description": "See the full history of an appointment: when it was booked, moved, cancelled, and more.", "tags": [ "Appointments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Appointment ID", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/appointments/:id/events Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsPositiveResponse" } } } }, "400": { "description": "GET /v2/appointments/:id/events Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsNegativeResponse400" } } } }, "401": { "description": "GET /v2/appointments/:id/events Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsNegativeResponse401" } } } }, "403": { "description": "GET /v2/appointments/:id/events Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsNegativeResponse403" } } } }, "404": { "description": "GET /v2/appointments/:id/events Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsNegativeResponse404" } } } }, "409": { "description": "GET /v2/appointments/:id/events Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsNegativeResponse409" } } } }, "422": { "description": "GET /v2/appointments/:id/events Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsNegativeResponse422" } } } }, "429": { "description": "GET /v2/appointments/:id/events Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsNegativeResponse429" } } } }, "500": { "description": "GET /v2/appointments/:id/events Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsNegativeResponse500" } } } }, "502": { "description": "GET /v2/appointments/:id/events Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsNegativeResponse502" } } } }, "503": { "description": "GET /v2/appointments/:id/events Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdEventsNegativeResponse503" } } } } } } }, "/v2/appointments/{id}": { "get": { "operationId": "GetV2AppointmentsId", "summary": "Fetch a single appointment by id", "description": "Look up one appointment by its ID.", "tags": [ "Appointments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Appointment ID", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/appointments/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdPositiveResponse" } } } }, "400": { "description": "GET /v2/appointments/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/appointments/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/appointments/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/appointments/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/appointments/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/appointments/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/appointments/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/appointments/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/appointments/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/appointments/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsIdNegativeResponse503" } } } } } } }, "/v2/appointments": { "get": { "operationId": "GetV2Appointments", "summary": "List appointments", "description": "List your organization's appointments.", "tags": [ "Appointments" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "description": "GET /v2/appointments Parameter", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "GET /v2/appointments Parameter", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterEndDate" } }, { "name": "member", "in": "query", "required": false, "description": "Comma-separated member UUIDs. Filter to appointments assigned to any of these members.", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterMember" } }, { "name": "clientCustomerId", "in": "query", "required": false, "description": "GET /v2/appointments Parameter", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterClientCustomerId" } }, { "name": "appointmentConfigId", "in": "query", "required": false, "description": "Comma-separated appointment config UUIDs. Filter to appointments using any of these scheduling configs.", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterAppointmentConfigId" } }, { "name": "campaignId", "in": "query", "required": false, "description": "Comma-separated campaign UUIDs. Filter to appointments originating from any of these campaigns.", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterCampaignId" } }, { "name": "status", "in": "query", "required": false, "description": "Comma-separated status filter. Omit to return all statuses.", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterStatus" } }, { "name": "bookingSource", "in": "query", "required": false, "description": "Comma-separated booking source filter", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterBookingSource" } }, { "name": "appointmentMode", "in": "query", "required": false, "description": "Comma-separated appointment mode filter", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterAppointmentMode" } }, { "name": "sort", "in": "query", "required": false, "description": "GET /v2/appointments Parameter", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterSort" } }, { "name": "limit", "in": "query", "required": false, "description": "GET /v2/appointments Parameter", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterLimit" } }, { "name": "cursor", "in": "query", "required": false, "description": "GET /v2/appointments Parameter", "schema": { "$ref": "#/components/schemas/GetV2AppointmentsParameterCursor" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/appointments Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsPositiveResponse" } } } }, "400": { "description": "GET /v2/appointments Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsNegativeResponse400" } } } }, "401": { "description": "GET /v2/appointments Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsNegativeResponse401" } } } }, "403": { "description": "GET /v2/appointments Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsNegativeResponse403" } } } }, "404": { "description": "GET /v2/appointments Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsNegativeResponse404" } } } }, "409": { "description": "GET /v2/appointments Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsNegativeResponse409" } } } }, "422": { "description": "GET /v2/appointments Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsNegativeResponse422" } } } }, "429": { "description": "GET /v2/appointments Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsNegativeResponse429" } } } }, "500": { "description": "GET /v2/appointments Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsNegativeResponse500" } } } }, "502": { "description": "GET /v2/appointments Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsNegativeResponse502" } } } }, "503": { "description": "GET /v2/appointments Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2AppointmentsNegativeResponse503" } } } } } } }, "/v2/booking-links/{code}": { "delete": { "operationId": "DeleteV2BookingLinksCode", "summary": "Revoke a booking link", "description": "Turn off a booking link so it can no longer be used to book.", "tags": [ "Appointments.Booking Links" ], "parameters": [ { "name": "code", "in": "path", "required": true, "description": "DELETE /v2/booking-links/:code Parameter", "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeParameterCode" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/booking-links/:code Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodePositiveResponse" } } } }, "400": { "description": "DELETE /v2/booking-links/:code Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/booking-links/:code Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/booking-links/:code Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/booking-links/:code Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/booking-links/:code Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/booking-links/:code Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/booking-links/:code Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/booking-links/:code Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/booking-links/:code Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/booking-links/:code Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2BookingLinksCodeNegativeResponse503" } } } } } } }, "/v2/booking-links": { "get": { "operationId": "GetV2BookingLinks", "summary": "List booking links", "description": "List the self-booking links you've made for customers. Revoked links are left out unless you set includeRevoked=true.", "tags": [ "Appointments.Booking Links" ], "parameters": [ { "name": "clientCustomerId", "in": "query", "required": false, "description": "GET /v2/booking-links Parameter", "schema": { "$ref": "#/components/schemas/GetV2BookingLinksParameterClientCustomerId" } }, { "name": "appointmentConfigId", "in": "query", "required": false, "description": "GET /v2/booking-links Parameter", "schema": { "$ref": "#/components/schemas/GetV2BookingLinksParameterAppointmentConfigId" } }, { "name": "includeRevoked", "in": "query", "required": false, "description": "GET /v2/booking-links Parameter", "schema": { "$ref": "#/components/schemas/GetV2BookingLinksParameterIncludeRevoked" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/booking-links Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksPositiveResponse" } } } }, "400": { "description": "GET /v2/booking-links Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksNegativeResponse400" } } } }, "401": { "description": "GET /v2/booking-links Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksNegativeResponse401" } } } }, "403": { "description": "GET /v2/booking-links Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksNegativeResponse403" } } } }, "404": { "description": "GET /v2/booking-links Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksNegativeResponse404" } } } }, "409": { "description": "GET /v2/booking-links Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksNegativeResponse409" } } } }, "422": { "description": "GET /v2/booking-links Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksNegativeResponse422" } } } }, "429": { "description": "GET /v2/booking-links Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksNegativeResponse429" } } } }, "500": { "description": "GET /v2/booking-links Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksNegativeResponse500" } } } }, "502": { "description": "GET /v2/booking-links Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksNegativeResponse502" } } } }, "503": { "description": "GET /v2/booking-links Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2BookingLinksNegativeResponse503" } } } } } }, "post": { "operationId": "PostV2BookingLinks", "summary": "Get or create a booking link", "description": "Get a link a customer can use to book their own appointment on a booking calendar. If that customer already has a link for that calendar, you get the same link back. Links last until you revoke them, unless you set expiresAt.", "tags": [ "Appointments.Booking Links" ], "requestBody": { "description": "POST /v2/booking-links Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/booking-links Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksPositiveResponse" } } } }, "400": { "description": "POST /v2/booking-links Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksNegativeResponse400" } } } }, "401": { "description": "POST /v2/booking-links Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksNegativeResponse401" } } } }, "403": { "description": "POST /v2/booking-links Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksNegativeResponse403" } } } }, "404": { "description": "POST /v2/booking-links Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksNegativeResponse404" } } } }, "409": { "description": "POST /v2/booking-links Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksNegativeResponse409" } } } }, "422": { "description": "POST /v2/booking-links Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksNegativeResponse422" } } } }, "429": { "description": "POST /v2/booking-links Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksNegativeResponse429" } } } }, "500": { "description": "POST /v2/booking-links Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksNegativeResponse500" } } } }, "502": { "description": "POST /v2/booking-links Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksNegativeResponse502" } } } }, "503": { "description": "POST /v2/booking-links Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2BookingLinksNegativeResponse503" } } } } } } }, "/v2/campaigns/options": { "get": { "operationId": "GetV2CampaignsOptions", "summary": "List Campaign Options", "description": "Get a short list of your campaigns with only their ID, name, status, and tags. Handy for filters and pickers. Requires the customers:view permission.", "tags": [ "Campaigns" ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/options Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/options Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/options Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/options Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/options Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/options Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/options Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/options Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/options Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/options Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/options Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsOptionsNegativeResponse503" } } } } } } }, "/v2/campaigns/campaign-templates": { "get": { "operationId": "GetV2CampaignsCampaignTemplates", "summary": "List Campaign Templates", "description": "List the ready-made templates you can start a campaign from. Each one includes its call outcomes (dispositions) and Pulse workflow.", "tags": [ "Campaigns.Templates" ], "parameters": [ { "name": "tag", "in": "query", "required": false, "description": "GET /v2/campaigns/campaign-templates Parameter", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesParameterTag" } }, { "name": "vertical", "in": "query", "required": false, "description": "GET /v2/campaigns/campaign-templates Parameter", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesParameterVertical" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/campaign-templates Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/campaign-templates Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/campaign-templates Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/campaign-templates Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/campaign-templates Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/campaign-templates Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/campaign-templates Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/campaign-templates Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/campaign-templates Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/campaign-templates Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/campaign-templates Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignTemplatesNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/agent-source-restrictions/{id}": { "delete": { "operationId": "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsId", "summary": "Delete agent source restriction", "description": "Unblock an agent so they can take calls from a source again.", "tags": [ "Campaigns.Agent Source Restrictions" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdParameterCampaignId" } }, { "name": "id", "in": "path", "required": true, "description": "Restriction ID", "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/campaigns/:campaignId/agent-source-restrictions/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/agent-source-restrictions": { "get": { "operationId": "GetV2CampaignsCampaignIdAgentSourceRestrictions", "summary": "Get agent source restrictions", "description": "See which agents are blocked from taking calls from which sources in a campaign.", "tags": [ "Campaigns.Agent Source Restrictions" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsParameterCampaignId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/:campaignId/agent-source-restrictions Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse503" } } } } } }, "post": { "operationId": "PostV2CampaignsCampaignIdAgentSourceRestrictions", "summary": "Create agent source restriction", "description": "Block an agent from taking calls that come from a certain source in a campaign.", "tags": [ "Campaigns.Agent Source Restrictions" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsParameterCampaignId" } } ], "requestBody": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsPositiveResponse" } } } }, "400": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse400" } } } }, "401": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse401" } } } }, "403": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse403" } } } }, "404": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse404" } } } }, "409": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse409" } } } }, "422": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse422" } } } }, "429": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse429" } } } }, "500": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse500" } } } }, "502": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse502" } } } }, "503": { "description": "POST /v2/campaigns/:campaignId/agent-source-restrictions Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/dispositions/bulk": { "post": { "operationId": "PostV2CampaignsCampaignIdDispositionsBulk", "summary": "Bulk Add Campaign Dispositions", "description": "Add multiple dispositions to a campaign at once", "tags": [ "Dispositions" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkParameterCampaignId" } } ], "requestBody": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkPositiveResponse" } } } }, "400": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse400" } } } }, "401": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse401" } } } }, "403": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse403" } } } }, "404": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse404" } } } }, "409": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse409" } } } }, "422": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse422" } } } }, "429": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse429" } } } }, "500": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse500" } } } }, "502": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse502" } } } }, "503": { "description": "POST /v2/campaigns/:campaignId/dispositions/bulk Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/dispositions/{dispositionId}": { "patch": { "operationId": "PatchV2CampaignsCampaignIdDispositionsDispositionId", "summary": "Update Campaign Disposition", "description": "Update a campaign disposition (enable/disable, snippet override)", "tags": [ "Dispositions" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdParameterCampaignId" } }, { "name": "dispositionId", "in": "path", "required": true, "description": "Disposition ID", "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdParameterDispositionId" } } ], "requestBody": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse503" } } } } } }, "delete": { "operationId": "DeleteV2CampaignsCampaignIdDispositionsDispositionId", "summary": "Remove Campaign Disposition", "description": "Remove a disposition from a campaign. System dispositions cannot be removed.", "tags": [ "Dispositions" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdParameterCampaignId" } }, { "name": "dispositionId", "in": "path", "required": true, "description": "Disposition ID to remove", "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdParameterDispositionId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/campaigns/:campaignId/dispositions/:dispositionId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/dispositions": { "get": { "operationId": "GetV2CampaignsCampaignIdDispositions", "summary": "Get Campaign Dispositions", "description": "Get dispositions configured for a campaign with resolved snippets", "tags": [ "Dispositions" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsParameterCampaignId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/:campaignId/dispositions Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/:campaignId/dispositions Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/:campaignId/dispositions Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/:campaignId/dispositions Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/:campaignId/dispositions Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/:campaignId/dispositions Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/:campaignId/dispositions Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/:campaignId/dispositions Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/:campaignId/dispositions Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/:campaignId/dispositions Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/:campaignId/dispositions Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdDispositionsNegativeResponse503" } } } } } }, "post": { "operationId": "PostV2CampaignsCampaignIdDispositions", "summary": "Add Campaign Disposition", "description": "Add a disposition to a campaign", "tags": [ "Dispositions" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsParameterCampaignId" } } ], "requestBody": { "description": "POST /v2/campaigns/:campaignId/dispositions Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/campaigns/:campaignId/dispositions Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsPositiveResponse" } } } }, "400": { "description": "POST /v2/campaigns/:campaignId/dispositions Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsNegativeResponse400" } } } }, "401": { "description": "POST /v2/campaigns/:campaignId/dispositions Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsNegativeResponse401" } } } }, "403": { "description": "POST /v2/campaigns/:campaignId/dispositions Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsNegativeResponse403" } } } }, "404": { "description": "POST /v2/campaigns/:campaignId/dispositions Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsNegativeResponse404" } } } }, "409": { "description": "POST /v2/campaigns/:campaignId/dispositions Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsNegativeResponse409" } } } }, "422": { "description": "POST /v2/campaigns/:campaignId/dispositions Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsNegativeResponse422" } } } }, "429": { "description": "POST /v2/campaigns/:campaignId/dispositions Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsNegativeResponse429" } } } }, "500": { "description": "POST /v2/campaigns/:campaignId/dispositions Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsNegativeResponse500" } } } }, "502": { "description": "POST /v2/campaigns/:campaignId/dispositions Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsNegativeResponse502" } } } }, "503": { "description": "POST /v2/campaigns/:campaignId/dispositions Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdDispositionsNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/available-snippets": { "get": { "operationId": "getCampaignAvailableSnippets", "summary": "Get Available Snippets for Campaign", "description": "List the prompt snippets this campaign can use, and whether each one is already assigned. Only snippets your organization can use for the campaign's line of business are included.", "tags": [ "Campaigns.Block Snippets" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsParameterCampaignId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/:campaignId/available-snippets Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/:campaignId/available-snippets Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/:campaignId/available-snippets Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/:campaignId/available-snippets Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/:campaignId/available-snippets Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/:campaignId/available-snippets Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/:campaignId/available-snippets Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/:campaignId/available-snippets Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/:campaignId/available-snippets Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/:campaignId/available-snippets Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/:campaignId/available-snippets Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/available-blocks": { "get": { "operationId": "getCampaignAvailableBlocks", "summary": "Get Available Blocks for Campaign", "description": "List the prompt blocks that can be added to this campaign.", "tags": [ "Campaigns.Block Snippets" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksParameterCampaignId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/:campaignId/available-blocks Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/:campaignId/available-blocks Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/:campaignId/available-blocks Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/:campaignId/available-blocks Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/:campaignId/available-blocks Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/:campaignId/available-blocks Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/:campaignId/available-blocks Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/:campaignId/available-blocks Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/:campaignId/available-blocks Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/:campaignId/available-blocks Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/:campaignId/available-blocks Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/block-snippets": { "get": { "operationId": "getCampaignBlockSnippets", "summary": "Get Campaign Block Snippet Assignments", "description": "See which snippet is assigned to each prompt block in a campaign.", "tags": [ "Campaigns.Block Snippets" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsParameterCampaignId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/:campaignId/block-snippets Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/:campaignId/block-snippets Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/:campaignId/block-snippets Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/:campaignId/block-snippets Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/:campaignId/block-snippets Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/:campaignId/block-snippets Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/:campaignId/block-snippets Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/:campaignId/block-snippets Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/:campaignId/block-snippets Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/:campaignId/block-snippets Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/:campaignId/block-snippets Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/enrollment/restart": { "post": { "operationId": "PostV2CampaignsCampaignIdEnrollmentRestart", "summary": "Restart customers in a campaign", "description": "Send customers back to the first step of a campaign they are already in. Requires campaign_enrollment.manage. Provide customer or customers (up to 1,000), identified by customerId or US phoneNumber. Returns HTTP 202 with a server-generated job ID for both individuals and lists. Invalid customer entries fail individually with invalid_customer_reference and validationErrors; valid entries continue. Invalid request structure still returns 422. Poll statusUrl for per-input results. An optional idempotencyKey protects retries of the same payload; without one, each submission creates a new request. Customers must already exist in your organization. See [Campaign API guide](/docs/api-reference/campaign-enrollment/guide) for restrictions and retries. They start over from the beginning of the currently published workflow. Customers who are not in the campaign are skipped.", "tags": [ "Campaign Enrollment" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "POST /v2/campaigns/:campaignId/enrollment/restart Parameter", "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartParameterCampaignId" } } ], "requestBody": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "202": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartPositiveResponse" } } } }, "400": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse400" } } } }, "401": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse401" } } } }, "403": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse403" } } } }, "404": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse404" } } } }, "409": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse409" } } } }, "422": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse422" } } } }, "429": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse429" } } } }, "500": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse500" } } } }, "502": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse502" } } } }, "503": { "description": "POST /v2/campaigns/:campaignId/enrollment/restart Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/enrollment/status": { "post": { "operationId": "PostV2CampaignsCampaignIdEnrollmentStatus", "summary": "Change customer campaign status", "description": "Mark customers in a campaign as completed, failed, or cancelled. Requires campaign_enrollment.manage. Provide customer or customers (up to 1,000), identified by customerId or US phoneNumber. Returns HTTP 202 with a server-generated job ID for both individuals and lists. Invalid customer entries fail individually with invalid_customer_reference and validationErrors; valid entries continue. Invalid request structure still returns 422. Poll statusUrl for per-input results. An optional idempotencyKey protects retries of the same payload; without one, each submission creates a new request. Customers must already exist in your organization. See [Campaign API guide](/docs/api-reference/campaign-enrollment/guide) for restrictions and retries. This stops future campaign outreach, but does not hang up a call in progress or cancel appointments. Customers who are not in the campaign are skipped.", "tags": [ "Campaign Enrollment" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "POST /v2/campaigns/:campaignId/enrollment/status Parameter", "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusParameterCampaignId" } } ], "requestBody": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "202": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusPositiveResponse" } } } }, "400": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse400" } } } }, "401": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse401" } } } }, "403": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse403" } } } }, "404": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse404" } } } }, "409": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse409" } } } }, "422": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse422" } } } }, "429": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse429" } } } }, "500": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse500" } } } }, "502": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse502" } } } }, "503": { "description": "POST /v2/campaigns/:campaignId/enrollment/status Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/enrollment/requests/{jobId}": { "get": { "operationId": "GetV2CampaignsCampaignIdEnrollmentRequestsJobId", "summary": "Get campaign action results", "description": "Check the results of a campaign request you sent earlier. Requires campaign_enrollment.manage. Returns durable, organization- and campaign-scoped results in input order. duplicateOf references the first input that resolved to the same customer; its action runs only once. Counts include duplicate input positions. Poll every 2-5 seconds until completed, partial, or failed. An execution_uncertain result must be reviewed before issuing a new request.", "tags": [ "Campaign Enrollment" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Parameter", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdParameterCampaignId" } }, { "name": "jobId", "in": "path", "required": true, "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Parameter", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdParameterJobId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/:campaignId/enrollment/requests/:jobId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/enrollment": { "post": { "operationId": "PostV2CampaignsCampaignIdEnrollment", "summary": "Add customers to a campaign", "description": "Add customers to a campaign so it starts reaching out to them. Requires campaign_enrollment.manage. Provide customer or customers (up to 1,000), identified by customerId or US phoneNumber. Returns HTTP 202 with a server-generated job ID for both individuals and lists. Invalid customer entries fail individually with invalid_customer_reference and validationErrors; valid entries continue. Invalid request structure still returns 422. Poll statusUrl for per-input results. An optional idempotencyKey protects retries of the same payload; without one, each submission creates a new request. Customers must already exist in your organization. See [Campaign API guide](/docs/api-reference/campaign-enrollment/guide) for restrictions and retries. Customers already in the campaign, or who already finished it, are not started over. A customer can be in more than one campaign at a time.", "tags": [ "Campaign Enrollment" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "POST /v2/campaigns/:campaignId/enrollment Parameter", "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentParameterCampaignId" } } ], "requestBody": { "description": "POST /v2/campaigns/:campaignId/enrollment Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "202": { "description": "POST /v2/campaigns/:campaignId/enrollment Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentPositiveResponse" } } } }, "400": { "description": "POST /v2/campaigns/:campaignId/enrollment Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentNegativeResponse400" } } } }, "401": { "description": "POST /v2/campaigns/:campaignId/enrollment Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentNegativeResponse401" } } } }, "403": { "description": "POST /v2/campaigns/:campaignId/enrollment Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentNegativeResponse403" } } } }, "404": { "description": "POST /v2/campaigns/:campaignId/enrollment Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentNegativeResponse404" } } } }, "409": { "description": "POST /v2/campaigns/:campaignId/enrollment Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentNegativeResponse409" } } } }, "422": { "description": "POST /v2/campaigns/:campaignId/enrollment Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentNegativeResponse422" } } } }, "429": { "description": "POST /v2/campaigns/:campaignId/enrollment Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentNegativeResponse429" } } } }, "500": { "description": "POST /v2/campaigns/:campaignId/enrollment Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentNegativeResponse500" } } } }, "502": { "description": "POST /v2/campaigns/:campaignId/enrollment Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentNegativeResponse502" } } } }, "503": { "description": "POST /v2/campaigns/:campaignId/enrollment Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsCampaignIdEnrollmentNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/behaviors": { "get": { "operationId": "listCanonicalCampaignBehaviors", "summary": "List campaign behaviors", "description": "List what the AI does in each situation on a campaign's calls. For example, transferring the caller or booking an appointment, set separately for business hours and after hours.", "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsParameterCampaignId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/:campaignId/behaviors Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/:campaignId/behaviors Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/:campaignId/behaviors Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/:campaignId/behaviors Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/:campaignId/behaviors Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/:campaignId/behaviors Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/:campaignId/behaviors Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/:campaignId/behaviors Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/:campaignId/behaviors Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/:campaignId/behaviors Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/:campaignId/behaviors Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdBehaviorsNegativeResponse503" } } } } } }, "put": { "operationId": "replaceCanonicalCampaignBehaviors", "summary": "Save campaign behaviors atomically", "description": "Replace all of a campaign's behaviors in one step. Send the complete list. Either every change is saved, or none are.", "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "PUT /v2/campaigns/:campaignId/behaviors Parameter", "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsParameterCampaignId" } } ], "requestBody": { "description": "PUT /v2/campaigns/:campaignId/behaviors Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PUT /v2/campaigns/:campaignId/behaviors Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsPositiveResponse" } } } }, "400": { "description": "PUT /v2/campaigns/:campaignId/behaviors Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsNegativeResponse400" } } } }, "401": { "description": "PUT /v2/campaigns/:campaignId/behaviors Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsNegativeResponse401" } } } }, "403": { "description": "PUT /v2/campaigns/:campaignId/behaviors Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsNegativeResponse403" } } } }, "404": { "description": "PUT /v2/campaigns/:campaignId/behaviors Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsNegativeResponse404" } } } }, "409": { "description": "PUT /v2/campaigns/:campaignId/behaviors Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsNegativeResponse409" } } } }, "422": { "description": "PUT /v2/campaigns/:campaignId/behaviors Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsNegativeResponse422" } } } }, "429": { "description": "PUT /v2/campaigns/:campaignId/behaviors Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsNegativeResponse429" } } } }, "500": { "description": "PUT /v2/campaigns/:campaignId/behaviors Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsNegativeResponse500" } } } }, "502": { "description": "PUT /v2/campaigns/:campaignId/behaviors Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsNegativeResponse502" } } } }, "503": { "description": "PUT /v2/campaigns/:campaignId/behaviors Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CampaignsCampaignIdBehaviorsNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/pulse-occupancy": { "get": { "operationId": "GetV2CampaignsCampaignIdPulseOccupancy", "summary": "Get Campaign Pulse Occupancy", "description": "See how many customers are at each step of a campaign's workflow right now.", "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyParameterCampaignId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/:campaignId/pulse-occupancy Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}/stats": { "get": { "operationId": "GetV2CampaignsCampaignIdStats", "summary": "Get Campaign Statistics", "description": "Get a campaign's numbers: customer statuses, outcomes, redials, and call attempts.", "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsParameterCampaignId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/:campaignId/stats Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/:campaignId/stats Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/:campaignId/stats Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/:campaignId/stats Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/:campaignId/stats Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/:campaignId/stats Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/:campaignId/stats Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/:campaignId/stats Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/:campaignId/stats Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/:campaignId/stats Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/:campaignId/stats Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdStatsNegativeResponse503" } } } } } } }, "/v2/campaigns/{campaignId}": { "get": { "operationId": "GetV2CampaignsCampaignId", "summary": "Get campaign by ID", "description": "Look up one campaign by its ID.", "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdParameterCampaignId" } }, { "name": "withClient", "in": "query", "required": false, "description": "Include client information in response", "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdParameterWithClient" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns/:campaignId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns/:campaignId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns/:campaignId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns/:campaignId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns/:campaignId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns/:campaignId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns/:campaignId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns/:campaignId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns/:campaignId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns/:campaignId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns/:campaignId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsCampaignIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2CampaignsCampaignId", "summary": "Update a campaign", "description": "Change a campaign's settings, like its name, description, retry rules, and text messages.", "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "description": "Campaign ID", "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdParameterCampaignId" } } ], "requestBody": { "description": "PATCH /v2/campaigns/:campaignId Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/campaigns/:campaignId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/campaigns/:campaignId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/campaigns/:campaignId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/campaigns/:campaignId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/campaigns/:campaignId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/campaigns/:campaignId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/campaigns/:campaignId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/campaigns/:campaignId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/campaigns/:campaignId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/campaigns/:campaignId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/campaigns/:campaignId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CampaignsCampaignIdNegativeResponse503" } } } } } } }, "/v2/campaigns": { "get": { "operationId": "GetV2Campaigns", "summary": "List Campaigns", "description": "List your campaigns, with customer counts for each one. Results come back one page at a time.", "tags": [ "Campaigns" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "GET /v2/campaigns Parameter", "schema": { "$ref": "#/components/schemas/GetV2CampaignsParameterPage" } }, { "name": "perPage", "in": "query", "required": false, "description": "GET /v2/campaigns Parameter", "schema": { "$ref": "#/components/schemas/GetV2CampaignsParameterPerPage" } }, { "name": "includeReceptionist", "in": "query", "required": false, "description": "Include the organization receptionist in configuration listings. Receptionists cannot be assigned sources.", "schema": { "$ref": "#/components/schemas/GetV2CampaignsParameterIncludeReceptionist" } }, { "name": "sortBy", "in": "query", "required": false, "description": "Field to sort by", "schema": { "$ref": "#/components/schemas/GetV2CampaignsParameterSortBy" } }, { "name": "sortDirection", "in": "query", "required": false, "description": "Sort direction", "schema": { "$ref": "#/components/schemas/GetV2CampaignsParameterSortDirection" } }, { "name": "search", "in": "query", "required": false, "description": "Search query for filtering campaigns by name or description", "schema": { "$ref": "#/components/schemas/GetV2CampaignsParameterSearch" } }, { "name": "status", "in": "query", "required": false, "description": "Filter campaigns by status", "schema": { "$ref": "#/components/schemas/GetV2CampaignsParameterStatus" } }, { "name": "kind", "in": "query", "required": false, "description": "Filter by campaign kind. 'voice_ai' returns voice-AI campaigns (and legacy null-kind); 'agent_first' returns agent-first dialers/desks.", "schema": { "$ref": "#/components/schemas/GetV2CampaignsParameterKind" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/campaigns Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsPositiveResponse" } } } }, "400": { "description": "GET /v2/campaigns Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsNegativeResponse400" } } } }, "401": { "description": "GET /v2/campaigns Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsNegativeResponse401" } } } }, "403": { "description": "GET /v2/campaigns Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsNegativeResponse403" } } } }, "404": { "description": "GET /v2/campaigns Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsNegativeResponse404" } } } }, "409": { "description": "GET /v2/campaigns Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsNegativeResponse409" } } } }, "422": { "description": "GET /v2/campaigns Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsNegativeResponse422" } } } }, "429": { "description": "GET /v2/campaigns Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsNegativeResponse429" } } } }, "500": { "description": "GET /v2/campaigns Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsNegativeResponse500" } } } }, "502": { "description": "GET /v2/campaigns Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsNegativeResponse502" } } } }, "503": { "description": "GET /v2/campaigns Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CampaignsNegativeResponse503" } } } } } }, "post": { "operationId": "createClientCampaign", "summary": "Create Campaign", "description": "Create a new campaign as a draft. You can start from a template.", "tags": [ "Campaigns" ], "requestBody": { "description": "POST /v2/campaigns Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/campaigns Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsPositiveResponse" } } } }, "400": { "description": "POST /v2/campaigns Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsNegativeResponse400" } } } }, "401": { "description": "POST /v2/campaigns Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsNegativeResponse401" } } } }, "403": { "description": "POST /v2/campaigns Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsNegativeResponse403" } } } }, "404": { "description": "POST /v2/campaigns Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsNegativeResponse404" } } } }, "409": { "description": "POST /v2/campaigns Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsNegativeResponse409" } } } }, "422": { "description": "POST /v2/campaigns Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsNegativeResponse422" } } } }, "429": { "description": "POST /v2/campaigns Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsNegativeResponse429" } } } }, "500": { "description": "POST /v2/campaigns Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsNegativeResponse500" } } } }, "502": { "description": "POST /v2/campaigns Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsNegativeResponse502" } } } }, "503": { "description": "POST /v2/campaigns Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CampaignsNegativeResponse503" } } } } } } }, "/v2/calls/count": { "get": { "operationId": "GetV2CallsCount", "summary": "Get Calls Count", "description": "Get the total count of calls matching filters. Separated from the main calls endpoint for faster initial page loads.", "tags": [ "Calls" ], "parameters": [ { "name": "search", "in": "query", "required": false, "description": "Search query: matches customer name, phone number, or disposition", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterSearch" } }, { "name": "customerId", "in": "query", "required": false, "description": "Filter calls by customer ID for exact customer call history", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterCustomerId" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterCampaignIds" } }, { "name": "agentUserIds", "in": "query", "required": false, "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterAgentUserIds" } }, { "name": "durationOperator", "in": "query", "required": false, "description": "Duration filter operator (less than or equal, greater than or equal)", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterDurationOperator" } }, { "name": "durationValue", "in": "query", "required": false, "description": "Duration value in seconds to filter by", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterDurationValue" } }, { "name": "direction", "in": "query", "required": false, "description": "Filter by call direction", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterDirection" } }, { "name": "callType", "in": "query", "required": false, "description": "Filter by call type: Voice AI or Softphone", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterCallType" } }, { "name": "startDate", "in": "query", "required": false, "description": "Start date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "End date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterEndDate" } }, { "name": "excludeDispositions", "in": "query", "required": false, "description": "Array of disposition names to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterExcludeDispositions" } }, { "name": "includeDispositions", "in": "query", "required": false, "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterIncludeDispositions" } }, { "name": "excludeSources", "in": "query", "required": false, "description": "Array of source ids to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterExcludeSources" } }, { "name": "includeTestCalls", "in": "query", "required": false, "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterIncludeTestCalls" } }, { "name": "connectedCallsOnly", "in": "query", "required": false, "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterConnectedCallsOnly" } }, { "name": "includeErrorDispositions", "in": "query", "required": false, "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "schema": { "$ref": "#/components/schemas/GetV2CallsCountParameterIncludeErrorDispositions" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/count Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/count Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/count Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/count Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/count Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/count Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/count Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/count Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/count Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/count Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/count Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsCountNegativeResponse503" } } } } } } }, "/v2/calls/agents": { "get": { "operationId": "GetV2CallsAgents", "summary": "Get Softphone Call Agents", "description": "Get agents who have handled softphone calls visible to the user", "tags": [ "Calls" ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/agents Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/agents Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/agents Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/agents Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/agents Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/agents Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/agents Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/agents Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/agents Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/agents Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/agents Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsAgentsNegativeResponse503" } } } } } } }, "/v2/calls/metrics/access": { "get": { "operationId": "GetV2CallsMetricsAccess", "summary": "Get missed inbound callers and later agent connec…", "tags": [ "Calls Metrics" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterEndDate" } }, { "name": "direction", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterDirection" } }, { "name": "handler", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterHandler" } }, { "name": "intervalMinutes", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterIntervalMinutes" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterCampaignIds" } }, { "name": "transferConfigIds", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterTransferConfigIds" } }, { "name": "accessPage", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterAccessPage" } }, { "name": "accessOutcome", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterAccessOutcome" } }, { "name": "accessView", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterAccessView" } }, { "name": "accessCaller", "in": "query", "required": false, "description": "GET /v2/calls/metrics/access Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessParameterAccessCaller" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/metrics/access Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/metrics/access Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/metrics/access Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/metrics/access Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/metrics/access Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/metrics/access Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/metrics/access Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/metrics/access Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/metrics/access Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/metrics/access Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/metrics/access Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAccessNegativeResponse503" } } } } } } }, "/v2/calls/metrics/analytics-operations": { "get": { "operationId": "GetV2CallsMetricsAnalyticsOperations", "summary": "Get scoped call analytics interval reports", "description": "Volume, handled dispositions, busiest intervals and interval/day detail using the same filters and self/organization scope as Call Analytics.", "tags": [ "Calls Metrics" ], "parameters": [ { "name": "search", "in": "query", "required": false, "description": "Search query: matches customer name, phone number, or disposition", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterSearch" } }, { "name": "customerId", "in": "query", "required": false, "description": "Filter calls by customer ID for exact customer call history", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterCustomerId" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterCampaignIds" } }, { "name": "agentUserIds", "in": "query", "required": false, "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterAgentUserIds" } }, { "name": "durationOperator", "in": "query", "required": false, "description": "Duration filter operator (less than or equal, greater than or equal)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterDurationOperator" } }, { "name": "durationValue", "in": "query", "required": false, "description": "Duration value in seconds to filter by", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterDurationValue" } }, { "name": "direction", "in": "query", "required": false, "description": "Filter by call direction", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterDirection" } }, { "name": "callType", "in": "query", "required": false, "description": "Filter by call type: Voice AI or Softphone", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterCallType" } }, { "name": "startDate", "in": "query", "required": false, "description": "Start date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "End date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterEndDate" } }, { "name": "excludeDispositions", "in": "query", "required": false, "description": "Array of disposition names to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterExcludeDispositions" } }, { "name": "includeDispositions", "in": "query", "required": false, "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterIncludeDispositions" } }, { "name": "excludeSources", "in": "query", "required": false, "description": "Array of source ids to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterExcludeSources" } }, { "name": "includeTestCalls", "in": "query", "required": false, "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterIncludeTestCalls" } }, { "name": "connectedCallsOnly", "in": "query", "required": false, "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterConnectedCallsOnly" } }, { "name": "includeErrorDispositions", "in": "query", "required": false, "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterIncludeErrorDispositions" } }, { "name": "intervalMinutes", "in": "query", "required": false, "description": "GET /v2/calls/metrics/analytics-operations Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsParameterIntervalMinutes" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/metrics/analytics-operations Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/metrics/analytics-operations Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/metrics/analytics-operations Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/metrics/analytics-operations Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/metrics/analytics-operations Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/metrics/analytics-operations Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/metrics/analytics-operations Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/metrics/analytics-operations Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/metrics/analytics-operations Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/metrics/analytics-operations Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/metrics/analytics-operations Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsAnalyticsOperationsNegativeResponse503" } } } } } } }, "/v2/calls/metrics/operations": { "get": { "operationId": "GetV2CallsMetricsOperations", "summary": "Get call operations interval report", "description": "One consistent call-start-cohort dataset for ACD cards, volume, handled dispositions, busiest intervals, interval/day detail and export. Includes inbound/outbound, Voice AI, softphone, transfers and multiple-agent calls. Missing timing remains explicit.", "tags": [ "Calls Metrics" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "description": "GET /v2/calls/metrics/operations Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "GET /v2/calls/metrics/operations Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsParameterEndDate" } }, { "name": "direction", "in": "query", "required": false, "description": "GET /v2/calls/metrics/operations Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsParameterDirection" } }, { "name": "handler", "in": "query", "required": false, "description": "GET /v2/calls/metrics/operations Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsParameterHandler" } }, { "name": "intervalMinutes", "in": "query", "required": false, "description": "GET /v2/calls/metrics/operations Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsParameterIntervalMinutes" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "GET /v2/calls/metrics/operations Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsParameterCampaignIds" } }, { "name": "transferConfigIds", "in": "query", "required": false, "description": "GET /v2/calls/metrics/operations Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsParameterTransferConfigIds" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/metrics/operations Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/metrics/operations Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/metrics/operations Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/metrics/operations Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/metrics/operations Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/metrics/operations Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/metrics/operations Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/metrics/operations Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/metrics/operations Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/metrics/operations Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/metrics/operations Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsOperationsNegativeResponse503" } } } } } } }, "/v2/calls/metrics/summary": { "get": { "operationId": "GetV2CallsMetricsSummary", "summary": "Get calls summary metrics", "description": "Aggregate KPIs for the calls dashboard: totals, direction split, avg duration, voicemail/appointment/DNC rates.", "tags": [ "Calls Metrics" ], "parameters": [ { "name": "search", "in": "query", "required": false, "description": "Search query: matches customer name, phone number, or disposition", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterSearch" } }, { "name": "customerId", "in": "query", "required": false, "description": "Filter calls by customer ID for exact customer call history", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterCustomerId" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterCampaignIds" } }, { "name": "agentUserIds", "in": "query", "required": false, "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterAgentUserIds" } }, { "name": "durationOperator", "in": "query", "required": false, "description": "Duration filter operator (less than or equal, greater than or equal)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterDurationOperator" } }, { "name": "durationValue", "in": "query", "required": false, "description": "Duration value in seconds to filter by", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterDurationValue" } }, { "name": "direction", "in": "query", "required": false, "description": "Filter by call direction", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterDirection" } }, { "name": "callType", "in": "query", "required": false, "description": "Filter by call type: Voice AI or Softphone", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterCallType" } }, { "name": "startDate", "in": "query", "required": false, "description": "Start date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "End date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterEndDate" } }, { "name": "excludeDispositions", "in": "query", "required": false, "description": "Array of disposition names to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterExcludeDispositions" } }, { "name": "includeDispositions", "in": "query", "required": false, "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterIncludeDispositions" } }, { "name": "excludeSources", "in": "query", "required": false, "description": "Array of source ids to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterExcludeSources" } }, { "name": "includeTestCalls", "in": "query", "required": false, "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterIncludeTestCalls" } }, { "name": "connectedCallsOnly", "in": "query", "required": false, "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterConnectedCallsOnly" } }, { "name": "includeErrorDispositions", "in": "query", "required": false, "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterIncludeErrorDispositions" } }, { "name": "campaigns", "in": "query", "required": false, "description": "GET /v2/calls/metrics/summary Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterCampaigns" } }, { "name": "sources", "in": "query", "required": false, "description": "GET /v2/calls/metrics/summary Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryParameterSources" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/metrics/summary Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/metrics/summary Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/metrics/summary Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/metrics/summary Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/metrics/summary Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/metrics/summary Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/metrics/summary Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/metrics/summary Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/metrics/summary Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/metrics/summary Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/metrics/summary Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsSummaryNegativeResponse503" } } } } } } }, "/v2/calls/metrics/volume-time-series": { "get": { "operationId": "GetV2CallsMetricsVolumeTimeSeries", "summary": "Get calls volume over time", "description": "Returns inbound/outbound/total call counts bucketed by hour (≤2-day range) or day.", "tags": [ "Calls Metrics" ], "parameters": [ { "name": "search", "in": "query", "required": false, "description": "Search query: matches customer name, phone number, or disposition", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterSearch" } }, { "name": "customerId", "in": "query", "required": false, "description": "Filter calls by customer ID for exact customer call history", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterCustomerId" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterCampaignIds" } }, { "name": "agentUserIds", "in": "query", "required": false, "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterAgentUserIds" } }, { "name": "durationOperator", "in": "query", "required": false, "description": "Duration filter operator (less than or equal, greater than or equal)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterDurationOperator" } }, { "name": "durationValue", "in": "query", "required": false, "description": "Duration value in seconds to filter by", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterDurationValue" } }, { "name": "direction", "in": "query", "required": false, "description": "Filter by call direction", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterDirection" } }, { "name": "callType", "in": "query", "required": false, "description": "Filter by call type: Voice AI or Softphone", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterCallType" } }, { "name": "startDate", "in": "query", "required": false, "description": "Start date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "End date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterEndDate" } }, { "name": "excludeDispositions", "in": "query", "required": false, "description": "Array of disposition names to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterExcludeDispositions" } }, { "name": "includeDispositions", "in": "query", "required": false, "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterIncludeDispositions" } }, { "name": "excludeSources", "in": "query", "required": false, "description": "Array of source ids to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterExcludeSources" } }, { "name": "includeTestCalls", "in": "query", "required": false, "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterIncludeTestCalls" } }, { "name": "connectedCallsOnly", "in": "query", "required": false, "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterConnectedCallsOnly" } }, { "name": "includeErrorDispositions", "in": "query", "required": false, "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterIncludeErrorDispositions" } }, { "name": "campaigns", "in": "query", "required": false, "description": "GET /v2/calls/metrics/volume-time-series Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterCampaigns" } }, { "name": "sources", "in": "query", "required": false, "description": "GET /v2/calls/metrics/volume-time-series Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesParameterSources" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/metrics/volume-time-series Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/metrics/volume-time-series Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/metrics/volume-time-series Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/metrics/volume-time-series Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/metrics/volume-time-series Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/metrics/volume-time-series Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/metrics/volume-time-series Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/metrics/volume-time-series Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/metrics/volume-time-series Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/metrics/volume-time-series Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/metrics/volume-time-series Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsVolumeTimeSeriesNegativeResponse503" } } } } } } }, "/v2/calls/metrics/by-disposition": { "get": { "operationId": "GetV2CallsMetricsByDisposition", "summary": "Get calls by disposition", "description": "Counts grouped by disposition (descending).", "tags": [ "Calls Metrics" ], "parameters": [ { "name": "search", "in": "query", "required": false, "description": "Search query: matches customer name, phone number, or disposition", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterSearch" } }, { "name": "customerId", "in": "query", "required": false, "description": "Filter calls by customer ID for exact customer call history", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterCustomerId" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterCampaignIds" } }, { "name": "agentUserIds", "in": "query", "required": false, "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterAgentUserIds" } }, { "name": "durationOperator", "in": "query", "required": false, "description": "Duration filter operator (less than or equal, greater than or equal)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterDurationOperator" } }, { "name": "durationValue", "in": "query", "required": false, "description": "Duration value in seconds to filter by", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterDurationValue" } }, { "name": "direction", "in": "query", "required": false, "description": "Filter by call direction", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterDirection" } }, { "name": "callType", "in": "query", "required": false, "description": "Filter by call type: Voice AI or Softphone", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterCallType" } }, { "name": "startDate", "in": "query", "required": false, "description": "Start date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "End date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterEndDate" } }, { "name": "excludeDispositions", "in": "query", "required": false, "description": "Array of disposition names to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterExcludeDispositions" } }, { "name": "includeDispositions", "in": "query", "required": false, "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterIncludeDispositions" } }, { "name": "excludeSources", "in": "query", "required": false, "description": "Array of source ids to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterExcludeSources" } }, { "name": "includeTestCalls", "in": "query", "required": false, "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterIncludeTestCalls" } }, { "name": "connectedCallsOnly", "in": "query", "required": false, "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterConnectedCallsOnly" } }, { "name": "includeErrorDispositions", "in": "query", "required": false, "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterIncludeErrorDispositions" } }, { "name": "campaigns", "in": "query", "required": false, "description": "GET /v2/calls/metrics/by-disposition Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterCampaigns" } }, { "name": "sources", "in": "query", "required": false, "description": "GET /v2/calls/metrics/by-disposition Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionParameterSources" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/metrics/by-disposition Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/metrics/by-disposition Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/metrics/by-disposition Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/metrics/by-disposition Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/metrics/by-disposition Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/metrics/by-disposition Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/metrics/by-disposition Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/metrics/by-disposition Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/metrics/by-disposition Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/metrics/by-disposition Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/metrics/by-disposition Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByDispositionNegativeResponse503" } } } } } } }, "/v2/calls/metrics/by-campaign": { "get": { "operationId": "GetV2CallsMetricsByCampaign", "summary": "Get calls by campaign", "description": "Counts and average durations grouped by campaign (descending by count).", "tags": [ "Calls Metrics" ], "parameters": [ { "name": "search", "in": "query", "required": false, "description": "Search query: matches customer name, phone number, or disposition", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterSearch" } }, { "name": "customerId", "in": "query", "required": false, "description": "Filter calls by customer ID for exact customer call history", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterCustomerId" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterCampaignIds" } }, { "name": "agentUserIds", "in": "query", "required": false, "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterAgentUserIds" } }, { "name": "durationOperator", "in": "query", "required": false, "description": "Duration filter operator (less than or equal, greater than or equal)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterDurationOperator" } }, { "name": "durationValue", "in": "query", "required": false, "description": "Duration value in seconds to filter by", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterDurationValue" } }, { "name": "direction", "in": "query", "required": false, "description": "Filter by call direction", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterDirection" } }, { "name": "callType", "in": "query", "required": false, "description": "Filter by call type: Voice AI or Softphone", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterCallType" } }, { "name": "startDate", "in": "query", "required": false, "description": "Start date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "End date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterEndDate" } }, { "name": "excludeDispositions", "in": "query", "required": false, "description": "Array of disposition names to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterExcludeDispositions" } }, { "name": "includeDispositions", "in": "query", "required": false, "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterIncludeDispositions" } }, { "name": "excludeSources", "in": "query", "required": false, "description": "Array of source ids to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterExcludeSources" } }, { "name": "includeTestCalls", "in": "query", "required": false, "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterIncludeTestCalls" } }, { "name": "connectedCallsOnly", "in": "query", "required": false, "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterConnectedCallsOnly" } }, { "name": "includeErrorDispositions", "in": "query", "required": false, "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterIncludeErrorDispositions" } }, { "name": "campaigns", "in": "query", "required": false, "description": "GET /v2/calls/metrics/by-campaign Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterCampaigns" } }, { "name": "sources", "in": "query", "required": false, "description": "GET /v2/calls/metrics/by-campaign Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignParameterSources" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/metrics/by-campaign Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/metrics/by-campaign Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/metrics/by-campaign Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/metrics/by-campaign Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/metrics/by-campaign Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/metrics/by-campaign Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/metrics/by-campaign Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/metrics/by-campaign Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/metrics/by-campaign Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/metrics/by-campaign Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/metrics/by-campaign Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsByCampaignNegativeResponse503" } } } } } } }, "/v2/calls/metrics/duration-buckets": { "get": { "operationId": "GetV2CallsMetricsDurationBuckets", "summary": "Get calls duration distribution", "description": "Histogram of call durations bucketed into <30s, 30-60s, 1-3m, 3-5m, 5m+.", "tags": [ "Calls Metrics" ], "parameters": [ { "name": "search", "in": "query", "required": false, "description": "Search query: matches customer name, phone number, or disposition", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterSearch" } }, { "name": "customerId", "in": "query", "required": false, "description": "Filter calls by customer ID for exact customer call history", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterCustomerId" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterCampaignIds" } }, { "name": "agentUserIds", "in": "query", "required": false, "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterAgentUserIds" } }, { "name": "durationOperator", "in": "query", "required": false, "description": "Duration filter operator (less than or equal, greater than or equal)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterDurationOperator" } }, { "name": "durationValue", "in": "query", "required": false, "description": "Duration value in seconds to filter by", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterDurationValue" } }, { "name": "direction", "in": "query", "required": false, "description": "Filter by call direction", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterDirection" } }, { "name": "callType", "in": "query", "required": false, "description": "Filter by call type: Voice AI or Softphone", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterCallType" } }, { "name": "startDate", "in": "query", "required": false, "description": "Start date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "End date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterEndDate" } }, { "name": "excludeDispositions", "in": "query", "required": false, "description": "Array of disposition names to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterExcludeDispositions" } }, { "name": "includeDispositions", "in": "query", "required": false, "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterIncludeDispositions" } }, { "name": "excludeSources", "in": "query", "required": false, "description": "Array of source ids to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterExcludeSources" } }, { "name": "includeTestCalls", "in": "query", "required": false, "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterIncludeTestCalls" } }, { "name": "connectedCallsOnly", "in": "query", "required": false, "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterConnectedCallsOnly" } }, { "name": "includeErrorDispositions", "in": "query", "required": false, "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterIncludeErrorDispositions" } }, { "name": "campaigns", "in": "query", "required": false, "description": "GET /v2/calls/metrics/duration-buckets Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterCampaigns" } }, { "name": "sources", "in": "query", "required": false, "description": "GET /v2/calls/metrics/duration-buckets Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsParameterSources" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/metrics/duration-buckets Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/metrics/duration-buckets Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/metrics/duration-buckets Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/metrics/duration-buckets Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/metrics/duration-buckets Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/metrics/duration-buckets Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/metrics/duration-buckets Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/metrics/duration-buckets Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/metrics/duration-buckets Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/metrics/duration-buckets Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/metrics/duration-buckets Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsMetricsDurationBucketsNegativeResponse503" } } } } } } }, "/v2/calls/{id}/recording": { "get": { "operationId": "GetV2CallsIdRecording", "summary": "Get Recording URL", "description": "Get recording readiness and, when ready, a signed playback URL. Setting download=true requires calls export permission and requests attachment disposition.", "tags": [ "Calls" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Call ID", "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingParameterId" } }, { "name": "channel", "in": "query", "required": false, "description": "Which recording channel to retrieve", "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingParameterChannel" } }, { "name": "download", "in": "query", "required": false, "description": "When true, signed S3 URLs request attachment disposition", "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingParameterDownload" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/:id/recording Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/:id/recording Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/:id/recording Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/:id/recording Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/:id/recording Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/:id/recording Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/:id/recording Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/:id/recording Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/:id/recording Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/:id/recording Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/:id/recording Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdRecordingNegativeResponse503" } } } } } } }, "/v2/calls/{id}": { "get": { "operationId": "GetV2CallsId", "summary": "Get Call by ID", "description": "Get single call by ID with full details", "tags": [ "Calls" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Call ID", "schema": { "$ref": "#/components/schemas/GetV2CallsIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdPositiveResponse" } } } }, "400": { "description": "GET /v2/calls/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsIdNegativeResponse503" } } } } } } }, "/v2/calls": { "get": { "operationId": "GetV2Calls", "summary": "Get All Calls", "description": "Get paginated calls for authenticated client with descriptive field names", "tags": [ "Calls" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "GET /v2/calls Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterPage" } }, { "name": "perPage", "in": "query", "required": false, "description": "GET /v2/calls Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterPerPage" } }, { "name": "sortBy", "in": "query", "required": false, "description": "GET /v2/calls Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterSortBy" } }, { "name": "sortDirection", "in": "query", "required": false, "description": "GET /v2/calls Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterSortDirection" } }, { "name": "sortCustomFieldKey", "in": "query", "required": false, "description": "GET /v2/calls Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterSortCustomFieldKey" } }, { "name": "customFieldKeys", "in": "query", "required": false, "description": "GET /v2/calls Parameter", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterCustomFieldKeys" } }, { "name": "search", "in": "query", "required": false, "description": "Search query: matches customer name, phone number, or disposition", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterSearch" } }, { "name": "customerId", "in": "query", "required": false, "description": "Filter calls by customer ID for exact customer call history", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterCustomerId" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterCampaignIds" } }, { "name": "agentUserIds", "in": "query", "required": false, "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterAgentUserIds" } }, { "name": "durationOperator", "in": "query", "required": false, "description": "Duration filter operator (less than or equal, greater than or equal)", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterDurationOperator" } }, { "name": "durationValue", "in": "query", "required": false, "description": "Duration value in seconds to filter by", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterDurationValue" } }, { "name": "direction", "in": "query", "required": false, "description": "Filter by call direction", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterDirection" } }, { "name": "callType", "in": "query", "required": false, "description": "Filter by call type: Voice AI or Softphone", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterCallType" } }, { "name": "startDate", "in": "query", "required": false, "description": "Start date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "End date-time for call range filtering. ISO 8601 timestamp", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterEndDate" } }, { "name": "excludeDispositions", "in": "query", "required": false, "description": "Array of disposition names to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterExcludeDispositions" } }, { "name": "includeDispositions", "in": "query", "required": false, "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterIncludeDispositions" } }, { "name": "excludeSources", "in": "query", "required": false, "description": "Array of source ids to exclude from results (comma-separated string)", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterExcludeSources" } }, { "name": "includeTestCalls", "in": "query", "required": false, "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterIncludeTestCalls" } }, { "name": "connectedCallsOnly", "in": "query", "required": false, "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterConnectedCallsOnly" } }, { "name": "includeErrorDispositions", "in": "query", "required": false, "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterIncludeErrorDispositions" } }, { "name": "includeTotal", "in": "query", "required": false, "description": "When false, skips the exact count so the page can return independently. Use GET /v2/calls/count for the total.", "schema": { "$ref": "#/components/schemas/GetV2CallsParameterIncludeTotal" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/calls Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsPositiveResponse" } } } }, "400": { "description": "GET /v2/calls Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsNegativeResponse400" } } } }, "401": { "description": "GET /v2/calls Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsNegativeResponse401" } } } }, "403": { "description": "GET /v2/calls Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsNegativeResponse403" } } } }, "404": { "description": "GET /v2/calls Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsNegativeResponse404" } } } }, "409": { "description": "GET /v2/calls Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsNegativeResponse409" } } } }, "422": { "description": "GET /v2/calls Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsNegativeResponse422" } } } }, "429": { "description": "GET /v2/calls Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsNegativeResponse429" } } } }, "500": { "description": "GET /v2/calls Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsNegativeResponse500" } } } }, "502": { "description": "GET /v2/calls Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsNegativeResponse502" } } } }, "503": { "description": "GET /v2/calls Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CallsNegativeResponse503" } } } } } } }, "/v2/customers/agent-names": { "get": { "operationId": "GetV2CustomersAgentNames", "summary": "Get unique agent names", "description": "List the names of agents assigned to your customers, for use in filters.", "tags": [ "Customers" ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/customers/agent-names Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesPositiveResponse" } } } }, "400": { "description": "GET /v2/customers/agent-names Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesNegativeResponse400" } } } }, "401": { "description": "GET /v2/customers/agent-names Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesNegativeResponse401" } } } }, "403": { "description": "GET /v2/customers/agent-names Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesNegativeResponse403" } } } }, "404": { "description": "GET /v2/customers/agent-names Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesNegativeResponse404" } } } }, "409": { "description": "GET /v2/customers/agent-names Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesNegativeResponse409" } } } }, "422": { "description": "GET /v2/customers/agent-names Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesNegativeResponse422" } } } }, "429": { "description": "GET /v2/customers/agent-names Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesNegativeResponse429" } } } }, "500": { "description": "GET /v2/customers/agent-names Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesNegativeResponse500" } } } }, "502": { "description": "GET /v2/customers/agent-names Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesNegativeResponse502" } } } }, "503": { "description": "GET /v2/customers/agent-names Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersAgentNamesNegativeResponse503" } } } } } } }, "/v2/customers/carrier-names": { "get": { "operationId": "GetV2CustomersCarrierNames", "summary": "Get distinct carrier names for customers", "description": "List the insurance carriers on your customers' policies, for use in filters. You can limit it to a date range.", "tags": [ "Customers" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "description": "Carrier range start date. Format: YYYY-MM-DD", "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesParameterStartDate" } }, { "name": "endDate", "in": "query", "required": true, "description": "Carrier range end date. Format: YYYY-MM-DD", "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesParameterEndDate" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/customers/carrier-names Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesPositiveResponse" } } } }, "400": { "description": "GET /v2/customers/carrier-names Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesNegativeResponse400" } } } }, "401": { "description": "GET /v2/customers/carrier-names Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesNegativeResponse401" } } } }, "403": { "description": "GET /v2/customers/carrier-names Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesNegativeResponse403" } } } }, "404": { "description": "GET /v2/customers/carrier-names Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesNegativeResponse404" } } } }, "409": { "description": "GET /v2/customers/carrier-names Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesNegativeResponse409" } } } }, "422": { "description": "GET /v2/customers/carrier-names Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesNegativeResponse422" } } } }, "429": { "description": "GET /v2/customers/carrier-names Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesNegativeResponse429" } } } }, "500": { "description": "GET /v2/customers/carrier-names Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesNegativeResponse500" } } } }, "502": { "description": "GET /v2/customers/carrier-names Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesNegativeResponse502" } } } }, "503": { "description": "GET /v2/customers/carrier-names Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersCarrierNamesNegativeResponse503" } } } } } } }, "/v2/customers/tags": { "get": { "operationId": "GetV2CustomersTags", "summary": "Get customer tags", "description": "List all of your organization's tags and how many customers have each one. A new tag is created the first time you add it to a customer.", "tags": [ "Customers" ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/customers/tags Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsPositiveResponse" } } } }, "400": { "description": "GET /v2/customers/tags Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsNegativeResponse400" } } } }, "401": { "description": "GET /v2/customers/tags Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsNegativeResponse401" } } } }, "403": { "description": "GET /v2/customers/tags Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsNegativeResponse403" } } } }, "404": { "description": "GET /v2/customers/tags Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsNegativeResponse404" } } } }, "409": { "description": "GET /v2/customers/tags Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsNegativeResponse409" } } } }, "422": { "description": "GET /v2/customers/tags Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsNegativeResponse422" } } } }, "429": { "description": "GET /v2/customers/tags Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsNegativeResponse429" } } } }, "500": { "description": "GET /v2/customers/tags Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsNegativeResponse500" } } } }, "502": { "description": "GET /v2/customers/tags Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsNegativeResponse502" } } } }, "503": { "description": "GET /v2/customers/tags Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersTagsNegativeResponse503" } } } } } } }, "/v2/customers/{id}/prescriptions/{prescriptionId}": { "delete": { "operationId": "DeleteV2CustomersIdPrescriptionsPrescriptionId", "summary": "Delete customer prescription", "description": "Remove a prescription from a customer's record.", "tags": [ "Customers.Prescriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdParameterId" } }, { "name": "prescriptionId", "in": "path", "required": true, "description": "Prescription ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdParameterPrescriptionId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/customers/:id/prescriptions/:prescriptionId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2CustomersIdPrescriptionsPrescriptionId", "summary": "Update customer prescription", "description": "Change a prescription on a customer's record.", "tags": [ "Customers.Prescriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdParameterId" } }, { "name": "prescriptionId", "in": "path", "required": true, "description": "Prescription ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdParameterPrescriptionId" } } ], "requestBody": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/customers/:id/prescriptions/:prescriptionId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse503" } } } } } } }, "/v2/customers/{id}/prescriptions": { "post": { "operationId": "PostV2CustomersIdPrescriptions", "summary": "Create customer prescription", "description": "Add a prescription to a customer's record.", "tags": [ "Customers.Prescriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsParameterId" } } ], "requestBody": { "description": "POST /v2/customers/:id/prescriptions Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/customers/:id/prescriptions Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsPositiveResponse" } } } }, "400": { "description": "POST /v2/customers/:id/prescriptions Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsNegativeResponse400" } } } }, "401": { "description": "POST /v2/customers/:id/prescriptions Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsNegativeResponse401" } } } }, "403": { "description": "POST /v2/customers/:id/prescriptions Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsNegativeResponse403" } } } }, "404": { "description": "POST /v2/customers/:id/prescriptions Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsNegativeResponse404" } } } }, "409": { "description": "POST /v2/customers/:id/prescriptions Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsNegativeResponse409" } } } }, "422": { "description": "POST /v2/customers/:id/prescriptions Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsNegativeResponse422" } } } }, "429": { "description": "POST /v2/customers/:id/prescriptions Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsNegativeResponse429" } } } }, "500": { "description": "POST /v2/customers/:id/prescriptions Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsNegativeResponse500" } } } }, "502": { "description": "POST /v2/customers/:id/prescriptions Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsNegativeResponse502" } } } }, "503": { "description": "POST /v2/customers/:id/prescriptions Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPrescriptionsNegativeResponse503" } } } } } } }, "/v2/customers/{id}/providers/{providerId}": { "delete": { "operationId": "DeleteV2CustomersIdProvidersProviderId", "summary": "Delete customer provider", "description": "Remove a doctor or other healthcare provider from a customer's record.", "tags": [ "Customers.Providers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdParameterId" } }, { "name": "providerId", "in": "path", "required": true, "description": "Provider ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdParameterProviderId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/customers/:id/providers/:providerId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/customers/:id/providers/:providerId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/customers/:id/providers/:providerId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/customers/:id/providers/:providerId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/customers/:id/providers/:providerId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/customers/:id/providers/:providerId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/customers/:id/providers/:providerId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/customers/:id/providers/:providerId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/customers/:id/providers/:providerId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/customers/:id/providers/:providerId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/customers/:id/providers/:providerId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdProvidersProviderIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2CustomersIdProvidersProviderId", "summary": "Update customer provider", "description": "Change a doctor or other healthcare provider on a customer's record.", "tags": [ "Customers.Providers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdParameterId" } }, { "name": "providerId", "in": "path", "required": true, "description": "Provider ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdParameterProviderId" } } ], "requestBody": { "description": "PATCH /v2/customers/:id/providers/:providerId Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/customers/:id/providers/:providerId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/customers/:id/providers/:providerId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/customers/:id/providers/:providerId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/customers/:id/providers/:providerId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/customers/:id/providers/:providerId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/customers/:id/providers/:providerId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/customers/:id/providers/:providerId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/customers/:id/providers/:providerId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/customers/:id/providers/:providerId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/customers/:id/providers/:providerId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/customers/:id/providers/:providerId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdProvidersProviderIdNegativeResponse503" } } } } } } }, "/v2/customers/{id}/providers": { "post": { "operationId": "PostV2CustomersIdProviders", "summary": "Create customer provider", "description": "Add a doctor or other healthcare provider to a customer's record.", "tags": [ "Customers.Providers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersParameterId" } } ], "requestBody": { "description": "POST /v2/customers/:id/providers Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/customers/:id/providers Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersPositiveResponse" } } } }, "400": { "description": "POST /v2/customers/:id/providers Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersNegativeResponse400" } } } }, "401": { "description": "POST /v2/customers/:id/providers Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersNegativeResponse401" } } } }, "403": { "description": "POST /v2/customers/:id/providers Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersNegativeResponse403" } } } }, "404": { "description": "POST /v2/customers/:id/providers Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersNegativeResponse404" } } } }, "409": { "description": "POST /v2/customers/:id/providers Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersNegativeResponse409" } } } }, "422": { "description": "POST /v2/customers/:id/providers Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersNegativeResponse422" } } } }, "429": { "description": "POST /v2/customers/:id/providers Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersNegativeResponse429" } } } }, "500": { "description": "POST /v2/customers/:id/providers Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersNegativeResponse500" } } } }, "502": { "description": "POST /v2/customers/:id/providers Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersNegativeResponse502" } } } }, "503": { "description": "POST /v2/customers/:id/providers Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdProvidersNegativeResponse503" } } } } } } }, "/v2/customers/{id}/policies/{policyId}/custom-fields/{customFieldId}": { "delete": { "operationId": "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldId", "summary": "Delete policy custom field value", "description": "Clear a custom field on a policy. The `customFieldId` is the value ID returned in `policies[].customFields[].id` by `GET /v2/customers/:id`.", "tags": [ "Customers.Policies.Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterId" } }, { "name": "policyId", "in": "path", "required": true, "description": "Policy ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterPolicyId" } }, { "name": "customFieldId", "in": "path", "required": true, "description": "Custom field value ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterCustomFieldId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldId", "summary": "Update policy custom field value", "description": "Change a custom field's value on a policy. The `customFieldId` is the value ID returned in `policies[].customFields[].id` by `GET /v2/customers/:id`.", "tags": [ "Customers.Policies.Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterId" } }, { "name": "policyId", "in": "path", "required": true, "description": "Policy ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterPolicyId" } }, { "name": "customFieldId", "in": "path", "required": true, "description": "Custom field value ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterCustomFieldId" } } ], "requestBody": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse503" } } } } } } }, "/v2/customers/{id}/policies/{policyId}/custom-fields": { "post": { "operationId": "PostV2CustomersIdPoliciesPolicyIdCustomFields", "summary": "Create policy custom field value", "description": "Fill in a custom field on a policy. Get policy field definition IDs from `GET /v2/custom-fields?recordType=policies` or [Policy Custom Fields](https://app.carecycle.ai/settings/crm-settings/custom-fields/policy).", "tags": [ "Customers.Policies.Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsParameterId" } }, { "name": "policyId", "in": "path", "required": true, "description": "Policy ID", "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsParameterPolicyId" } } ], "requestBody": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsPositiveResponse" } } } }, "400": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse400" } } } }, "401": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse401" } } } }, "403": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse403" } } } }, "404": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse404" } } } }, "409": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse409" } } } }, "422": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse422" } } } }, "429": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse429" } } } }, "500": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse500" } } } }, "502": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse502" } } } }, "503": { "description": "POST /v2/customers/:id/policies/:policyId/custom-fields Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse503" } } } } } } }, "/v2/customers/{id}/policies/{policyId}": { "delete": { "operationId": "DeleteV2CustomersIdPoliciesPolicyId", "summary": "Delete customer policy", "description": "Remove a policy from a customer's record. It's hidden everywhere but kept for audit purposes. Requires the customer policy delete permission.", "tags": [ "Customers.Policies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdParameterId" } }, { "name": "policyId", "in": "path", "required": true, "description": "Policy ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdParameterPolicyId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/customers/:id/policies/:policyId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/customers/:id/policies/:policyId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/customers/:id/policies/:policyId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/customers/:id/policies/:policyId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/customers/:id/policies/:policyId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/customers/:id/policies/:policyId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/customers/:id/policies/:policyId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/customers/:id/policies/:policyId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/customers/:id/policies/:policyId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/customers/:id/policies/:policyId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/customers/:id/policies/:policyId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2CustomersIdPoliciesPolicyId", "summary": "Update customer policy", "description": "Change a policy on a customer's record.", "tags": [ "Customers.Policies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdParameterId" } }, { "name": "policyId", "in": "path", "required": true, "description": "Policy ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdParameterPolicyId" } } ], "requestBody": { "description": "PATCH /v2/customers/:id/policies/:policyId Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdRequestBody" }, "examples": { "example1": { "value": { "draftDay": 1 } }, "example2": { "value": { "draftDay": 15 } } } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/customers/:id/policies/:policyId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/customers/:id/policies/:policyId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/customers/:id/policies/:policyId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/customers/:id/policies/:policyId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/customers/:id/policies/:policyId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/customers/:id/policies/:policyId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/customers/:id/policies/:policyId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/customers/:id/policies/:policyId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/customers/:id/policies/:policyId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/customers/:id/policies/:policyId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/customers/:id/policies/:policyId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPoliciesPolicyIdNegativeResponse503" } } } } } } }, "/v2/customers/{id}/policies": { "post": { "operationId": "PostV2CustomersIdPolicies", "summary": "Create customer policy", "description": "Add an insurance policy to a customer's record.\n\n**Medicare plan codes**: For `MA` and `MAPD`, `planCode` must be a CMS contract-style code starting with `H` or `R`. For `PDP`, it must start with `S`, `H`, `R`, `E`, or `X`. The three-digit segment is optional: send contract+plan only (`H3146-036`) and careCycle infers the segment from CMS reference data, defaulting to `-000` for non-segmented plans; a record is rejected only when the plan genuinely has multiple segments (include the segment to disambiguate). Dashes are optional in requests (`H1234001000` and `H1234-001-000` are accepted); careCycle stores the canonical dashed form. `MS` plan codes are carrier-specific and are not required to follow the CMS contract format.", "tags": [ "Customers.Policies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesParameterId" } } ], "requestBody": { "description": "POST /v2/customers/:id/policies Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesRequestBody" }, "examples": { "example1": { "value": { "carrierName": "Aetna", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example2": { "value": { "carrierName": "Aetna", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example3": { "value": { "carrierName": "Aetna", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example4": { "value": { "carrierName": "Aetna", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example5": { "value": { "carrierName": "Aetna", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example6": { "value": { "carrierName": "Aetna", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example7": { "value": { "carrierName": "Aetna", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example8": { "value": { "carrierName": "Aetna", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example9": { "value": { "carrierName": "Aetna", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example10": { "value": { "carrierName": "Aetna", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example11": { "value": { "carrierName": "Aetna", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example12": { "value": { "carrierName": "Aetna", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example13": { "value": { "carrierName": "Aetna", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example14": { "value": { "carrierName": "Aetna", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example15": { "value": { "carrierName": "Aetna", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example16": { "value": { "carrierName": "Aetna", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example17": { "value": { "carrierName": "BCBS of TX", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example18": { "value": { "carrierName": "BCBS of TX", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example19": { "value": { "carrierName": "BCBS of TX", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example20": { "value": { "carrierName": "BCBS of TX", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example21": { "value": { "carrierName": "BCBS of TX", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example22": { "value": { "carrierName": "BCBS of TX", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example23": { "value": { "carrierName": "BCBS of TX", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example24": { "value": { "carrierName": "BCBS of TX", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example25": { "value": { "carrierName": "BCBS of TX", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example26": { "value": { "carrierName": "BCBS of TX", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example27": { "value": { "carrierName": "BCBS of TX", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example28": { "value": { "carrierName": "BCBS of TX", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example29": { "value": { "carrierName": "BCBS of TX", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example30": { "value": { "carrierName": "BCBS of TX", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example31": { "value": { "carrierName": "BCBS of TX", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example32": { "value": { "carrierName": "BCBS of TX", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example33": { "value": { "carrierName": "UHC", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example34": { "value": { "carrierName": "UHC", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example35": { "value": { "carrierName": "UHC", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example36": { "value": { "carrierName": "UHC", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example37": { "value": { "carrierName": "UHC", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example38": { "value": { "carrierName": "UHC", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example39": { "value": { "carrierName": "UHC", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example40": { "value": { "carrierName": "UHC", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example41": { "value": { "carrierName": "UHC", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example42": { "value": { "carrierName": "UHC", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example43": { "value": { "carrierName": "UHC", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example44": { "value": { "carrierName": "UHC", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example45": { "value": { "carrierName": "UHC", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example46": { "value": { "carrierName": "UHC", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example47": { "value": { "carrierName": "UHC", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example48": { "value": { "carrierName": "UHC", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example49": { "value": { "carrierName": "Anthem", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example50": { "value": { "carrierName": "Anthem", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example51": { "value": { "carrierName": "Anthem", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example52": { "value": { "carrierName": "Anthem", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example53": { "value": { "carrierName": "Anthem", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example54": { "value": { "carrierName": "Anthem", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example55": { "value": { "carrierName": "Anthem", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example56": { "value": { "carrierName": "Anthem", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example57": { "value": { "carrierName": "Anthem", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example58": { "value": { "carrierName": "Anthem", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example59": { "value": { "carrierName": "Anthem", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example60": { "value": { "carrierName": "Anthem", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example61": { "value": { "carrierName": "Anthem", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example62": { "value": { "carrierName": "Anthem", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example63": { "value": { "carrierName": "Anthem", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example64": { "value": { "carrierName": "Anthem", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example65": { "value": { "carrierName": "Florida Blue", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example66": { "value": { "carrierName": "Florida Blue", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example67": { "value": { "carrierName": "Florida Blue", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example68": { "value": { "carrierName": "Florida Blue", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example69": { "value": { "carrierName": "Florida Blue", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example70": { "value": { "carrierName": "Florida Blue", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example71": { "value": { "carrierName": "Florida Blue", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example72": { "value": { "carrierName": "Florida Blue", "planName": "Medicare Elite", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example73": { "value": { "carrierName": "Florida Blue", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example74": { "value": { "carrierName": "Florida Blue", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example75": { "value": { "carrierName": "Florida Blue", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example76": { "value": { "carrierName": "Florida Blue", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "John", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example77": { "value": { "carrierName": "Florida Blue", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example78": { "value": { "carrierName": "Florida Blue", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } }, "example79": { "value": { "carrierName": "Florida Blue", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 1 } }, "example80": { "value": { "carrierName": "Florida Blue", "planName": "Blue Cross PPO", "planCode": "H1290-036-001", "aorFirstName": "Jane", "aorLastName": "Smith", "aorNpn": "123456789", "policyLives": 3, "draftDay": 15 } } } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/customers/:id/policies Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesPositiveResponse" } } } }, "400": { "description": "POST /v2/customers/:id/policies Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesNegativeResponse400" } } } }, "401": { "description": "POST /v2/customers/:id/policies Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesNegativeResponse401" } } } }, "403": { "description": "POST /v2/customers/:id/policies Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesNegativeResponse403" } } } }, "404": { "description": "POST /v2/customers/:id/policies Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesNegativeResponse404" } } } }, "409": { "description": "POST /v2/customers/:id/policies Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesNegativeResponse409" } } } }, "422": { "description": "POST /v2/customers/:id/policies Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesNegativeResponse422" } } } }, "429": { "description": "POST /v2/customers/:id/policies Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesNegativeResponse429" } } } }, "500": { "description": "POST /v2/customers/:id/policies Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesNegativeResponse500" } } } }, "502": { "description": "POST /v2/customers/:id/policies Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesNegativeResponse502" } } } }, "503": { "description": "POST /v2/customers/:id/policies Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdPoliciesNegativeResponse503" } } } } } } }, "/v2/customers/{id}/custom-fields/{customFieldId}": { "delete": { "operationId": "DeleteV2CustomersIdCustomFieldsCustomFieldId", "summary": "Delete customer custom field value", "description": "Clear a custom field on a customer.", "tags": [ "Customers.Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdParameterId" } }, { "name": "customFieldId", "in": "path", "required": true, "description": "Custom field value ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdParameterCustomFieldId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/customers/:id/custom-fields/:customFieldId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2CustomersIdCustomFieldsCustomFieldId", "summary": "Update customer custom field value", "description": "Change a custom field's value on a customer.", "tags": [ "Customers.Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdParameterId" } }, { "name": "customFieldId", "in": "path", "required": true, "description": "Custom field value ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdParameterCustomFieldId" } } ], "requestBody": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/customers/:id/custom-fields/:customFieldId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse503" } } } } } } }, "/v2/customers/{id}/custom-fields": { "post": { "operationId": "PostV2CustomersIdCustomFields", "summary": "Create customer custom field value", "description": "Fill in a custom field on a customer.", "tags": [ "Customers.Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsParameterId" } } ], "requestBody": { "description": "POST /v2/customers/:id/custom-fields Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/customers/:id/custom-fields Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsPositiveResponse" } } } }, "400": { "description": "POST /v2/customers/:id/custom-fields Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsNegativeResponse400" } } } }, "401": { "description": "POST /v2/customers/:id/custom-fields Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsNegativeResponse401" } } } }, "403": { "description": "POST /v2/customers/:id/custom-fields Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsNegativeResponse403" } } } }, "404": { "description": "POST /v2/customers/:id/custom-fields Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsNegativeResponse404" } } } }, "409": { "description": "POST /v2/customers/:id/custom-fields Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsNegativeResponse409" } } } }, "422": { "description": "POST /v2/customers/:id/custom-fields Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsNegativeResponse422" } } } }, "429": { "description": "POST /v2/customers/:id/custom-fields Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsNegativeResponse429" } } } }, "500": { "description": "POST /v2/customers/:id/custom-fields Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsNegativeResponse500" } } } }, "502": { "description": "POST /v2/customers/:id/custom-fields Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsNegativeResponse502" } } } }, "503": { "description": "POST /v2/customers/:id/custom-fields Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdCustomFieldsNegativeResponse503" } } } } } } }, "/v2/customers/{id}/dependents/{dependentId}": { "delete": { "operationId": "DeleteV2CustomersIdDependentsDependentId", "summary": "Delete customer dependent", "description": "Remove a dependent, like a spouse or child, from a customer's record.", "tags": [ "Customers.Dependents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdParameterId" } }, { "name": "dependentId", "in": "path", "required": true, "description": "Dependent ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdParameterDependentId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/customers/:id/dependents/:dependentId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdDependentsDependentIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2CustomersIdDependentsDependentId", "summary": "Update customer dependent", "description": "Change a dependent's details on a customer's record.", "tags": [ "Customers.Dependents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdParameterId" } }, { "name": "dependentId", "in": "path", "required": true, "description": "Dependent ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdParameterDependentId" } } ], "requestBody": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/customers/:id/dependents/:dependentId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdDependentsDependentIdNegativeResponse503" } } } } } } }, "/v2/customers/{id}/dependents": { "post": { "operationId": "PostV2CustomersIdDependents", "summary": "Create customer dependent", "description": "Add a dependent, like a spouse or child, to a customer's record.", "tags": [ "Customers.Dependents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsParameterId" } } ], "requestBody": { "description": "POST /v2/customers/:id/dependents Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/customers/:id/dependents Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsPositiveResponse" } } } }, "400": { "description": "POST /v2/customers/:id/dependents Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsNegativeResponse400" } } } }, "401": { "description": "POST /v2/customers/:id/dependents Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsNegativeResponse401" } } } }, "403": { "description": "POST /v2/customers/:id/dependents Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsNegativeResponse403" } } } }, "404": { "description": "POST /v2/customers/:id/dependents Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsNegativeResponse404" } } } }, "409": { "description": "POST /v2/customers/:id/dependents Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsNegativeResponse409" } } } }, "422": { "description": "POST /v2/customers/:id/dependents Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsNegativeResponse422" } } } }, "429": { "description": "POST /v2/customers/:id/dependents Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsNegativeResponse429" } } } }, "500": { "description": "POST /v2/customers/:id/dependents Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsNegativeResponse500" } } } }, "502": { "description": "POST /v2/customers/:id/dependents Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsNegativeResponse502" } } } }, "503": { "description": "POST /v2/customers/:id/dependents Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdDependentsNegativeResponse503" } } } } } } }, "/v2/customers/{id}/tags/{tagId}": { "delete": { "operationId": "DeleteV2CustomersIdTagsTagId", "summary": "Remove customer tag", "description": "Take a tag off a customer. The tag itself stays in your organization's tag list, so you can use it again.", "tags": [ "Customers.Tags" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdParameterId" } }, { "name": "tagId", "in": "path", "required": true, "description": "Tag ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdParameterTagId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/customers/:id/tags/:tagId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/customers/:id/tags/:tagId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/customers/:id/tags/:tagId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/customers/:id/tags/:tagId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/customers/:id/tags/:tagId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/customers/:id/tags/:tagId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/customers/:id/tags/:tagId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/customers/:id/tags/:tagId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/customers/:id/tags/:tagId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/customers/:id/tags/:tagId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/customers/:id/tags/:tagId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdTagsTagIdNegativeResponse503" } } } } } } }, "/v2/customers/{id}/tags": { "post": { "operationId": "PostV2CustomersIdTags", "summary": "Add customer tag", "description": "Put a tag on a customer. Choose the customer with their ID in the URL, and send the tag's name in the body. If your organization doesn't have a tag with that name yet, it's created. Capital letters don't matter, so \"VIP\" and \"vip\" are the same tag. Adding a tag the customer already has changes nothing.", "tags": [ "Customers.Tags" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsParameterId" } } ], "requestBody": { "description": "POST /v2/customers/:id/tags Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/customers/:id/tags Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsPositiveResponse" } } } }, "400": { "description": "POST /v2/customers/:id/tags Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsNegativeResponse400" } } } }, "401": { "description": "POST /v2/customers/:id/tags Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsNegativeResponse401" } } } }, "403": { "description": "POST /v2/customers/:id/tags Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsNegativeResponse403" } } } }, "404": { "description": "POST /v2/customers/:id/tags Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsNegativeResponse404" } } } }, "409": { "description": "POST /v2/customers/:id/tags Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsNegativeResponse409" } } } }, "422": { "description": "POST /v2/customers/:id/tags Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsNegativeResponse422" } } } }, "429": { "description": "POST /v2/customers/:id/tags Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsNegativeResponse429" } } } }, "500": { "description": "POST /v2/customers/:id/tags Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsNegativeResponse500" } } } }, "502": { "description": "POST /v2/customers/:id/tags Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsNegativeResponse502" } } } }, "503": { "description": "POST /v2/customers/:id/tags Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdTagsNegativeResponse503" } } } } } } }, "/v2/customers/{id}/calls": { "get": { "operationId": "GetV2CustomersIdCalls", "summary": "Get paginated customer calls", "description": "List the calls you've had with a customer. Results come back one page at a time.", "tags": [ "Customers" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "GET /v2/customers/:id/calls Parameter", "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsParameterPage" } }, { "name": "perPage", "in": "query", "required": false, "description": "GET /v2/customers/:id/calls Parameter", "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsParameterPerPage" } }, { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsParameterId" } }, { "name": "sortBy", "in": "query", "required": false, "description": "Field to sort by", "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsParameterSortBy" } }, { "name": "sortDirection", "in": "query", "required": false, "description": "Sort direction", "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsParameterSortDirection" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/customers/:id/calls Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsPositiveResponse" } } } }, "400": { "description": "GET /v2/customers/:id/calls Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsNegativeResponse400" } } } }, "401": { "description": "GET /v2/customers/:id/calls Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsNegativeResponse401" } } } }, "403": { "description": "GET /v2/customers/:id/calls Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsNegativeResponse403" } } } }, "404": { "description": "GET /v2/customers/:id/calls Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsNegativeResponse404" } } } }, "409": { "description": "GET /v2/customers/:id/calls Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsNegativeResponse409" } } } }, "422": { "description": "GET /v2/customers/:id/calls Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsNegativeResponse422" } } } }, "429": { "description": "GET /v2/customers/:id/calls Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsNegativeResponse429" } } } }, "500": { "description": "GET /v2/customers/:id/calls Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsNegativeResponse500" } } } }, "502": { "description": "GET /v2/customers/:id/calls Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsNegativeResponse502" } } } }, "503": { "description": "GET /v2/customers/:id/calls Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdCallsNegativeResponse503" } } } } } } }, "/v2/customers/{id}/related": { "post": { "operationId": "PostV2CustomersIdRelated", "summary": "Add related customer", "description": "Add a person who shares this customer's phone number, such as a spouse, or link an existing customer. Call it when POST /v2/customers returns 409 with an existingCustomerId. A person already on the number is returned instead of duplicated, so retries are safe. The person is not the number's primary unless isPrimaryForPhone is true.", "tags": [ "Customers.Relationships" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer the person is related to", "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedParameterId" } } ], "requestBody": { "description": "POST /v2/customers/:id/related Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/customers/:id/related Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedPositiveResponse" } } } }, "400": { "description": "POST /v2/customers/:id/related Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedNegativeResponse400" } } } }, "401": { "description": "POST /v2/customers/:id/related Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedNegativeResponse401" } } } }, "403": { "description": "POST /v2/customers/:id/related Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedNegativeResponse403" } } } }, "404": { "description": "POST /v2/customers/:id/related Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedNegativeResponse404" } } } }, "409": { "description": "POST /v2/customers/:id/related Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedNegativeResponse409" } } } }, "422": { "description": "POST /v2/customers/:id/related Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedNegativeResponse422" } } } }, "429": { "description": "POST /v2/customers/:id/related Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedNegativeResponse429" } } } }, "500": { "description": "POST /v2/customers/:id/related Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedNegativeResponse500" } } } }, "502": { "description": "POST /v2/customers/:id/related Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedNegativeResponse502" } } } }, "503": { "description": "POST /v2/customers/:id/related Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdRelatedNegativeResponse503" } } } } } } }, "/v2/customers/{id}/make-primary": { "post": { "operationId": "PostV2CustomersIdMakePrimary", "summary": "Make customer the phone number's primary", "description": "Make this customer the primary for their phone number, for example when the main contact of a household changes. Inbound calls, texts and outreach for the number then go to this customer. The previous primary stays a customer, related to the number, and the number's text history moves to this customer.", "tags": [ "Customers.Relationships" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer who becomes the primary for their number", "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryParameterId" } } ], "requestBody": { "description": "POST /v2/customers/:id/make-primary Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/customers/:id/make-primary Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryPositiveResponse" } } } }, "400": { "description": "POST /v2/customers/:id/make-primary Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryNegativeResponse400" } } } }, "401": { "description": "POST /v2/customers/:id/make-primary Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryNegativeResponse401" } } } }, "403": { "description": "POST /v2/customers/:id/make-primary Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryNegativeResponse403" } } } }, "404": { "description": "POST /v2/customers/:id/make-primary Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryNegativeResponse404" } } } }, "409": { "description": "POST /v2/customers/:id/make-primary Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryNegativeResponse409" } } } }, "422": { "description": "POST /v2/customers/:id/make-primary Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryNegativeResponse422" } } } }, "429": { "description": "POST /v2/customers/:id/make-primary Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryNegativeResponse429" } } } }, "500": { "description": "POST /v2/customers/:id/make-primary Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryNegativeResponse500" } } } }, "502": { "description": "POST /v2/customers/:id/make-primary Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryNegativeResponse502" } } } }, "503": { "description": "POST /v2/customers/:id/make-primary Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersIdMakePrimaryNegativeResponse503" } } } } } } }, "/v2/customers/{id}/relationships/{relationshipId}": { "delete": { "operationId": "DeleteV2CustomersIdRelationshipsRelationshipId", "summary": "Remove customer relationship", "description": "Remove the link between two customers. Both customers and the phone number's primary stay unchanged.", "tags": [ "Customers.Relationships" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdParameterId" } }, { "name": "relationshipId", "in": "path", "required": true, "description": "Relationship ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdParameterRelationshipId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/customers/:id/relationships/:relationshipId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2CustomersIdRelationshipsRelationshipId", "summary": "Update customer relationship", "description": "Change how two linked customers are related", "tags": [ "Customers.Relationships" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdParameterId" } }, { "name": "relationshipId", "in": "path", "required": true, "description": "Relationship ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdParameterRelationshipId" } } ], "requestBody": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/customers/:id/relationships/:relationshipId Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse503" } } } } } } }, "/v2/customers/{id}/relationships": { "get": { "operationId": "GetV2CustomersIdRelationships", "summary": "List customer relationships", "description": "List the customers linked to this customer, with whether each shares this customer's phone number and which one is the number's primary.", "tags": [ "Customers.Relationships" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/customers/:id/relationships Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsPositiveResponse" } } } }, "400": { "description": "GET /v2/customers/:id/relationships Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsNegativeResponse400" } } } }, "401": { "description": "GET /v2/customers/:id/relationships Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsNegativeResponse401" } } } }, "403": { "description": "GET /v2/customers/:id/relationships Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsNegativeResponse403" } } } }, "404": { "description": "GET /v2/customers/:id/relationships Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsNegativeResponse404" } } } }, "409": { "description": "GET /v2/customers/:id/relationships Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsNegativeResponse409" } } } }, "422": { "description": "GET /v2/customers/:id/relationships Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsNegativeResponse422" } } } }, "429": { "description": "GET /v2/customers/:id/relationships Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsNegativeResponse429" } } } }, "500": { "description": "GET /v2/customers/:id/relationships Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsNegativeResponse500" } } } }, "502": { "description": "GET /v2/customers/:id/relationships Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsNegativeResponse502" } } } }, "503": { "description": "GET /v2/customers/:id/relationships Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdRelationshipsNegativeResponse503" } } } } } } }, "/v2/customers/{id}": { "delete": { "operationId": "DeleteV2CustomersId", "summary": "Delete customer by ID", "description": "Remove a customer from your lists. Their past calls and records are kept.", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/customers/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/customers/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/customers/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/customers/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/customers/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/customers/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/customers/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/customers/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/customers/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/customers/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/customers/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomersIdNegativeResponse503" } } } } } }, "get": { "operationId": "GetV2CustomersId", "summary": "Get customer by ID", "description": "Look up one customer and everything on their record. This includes policies, prescriptions, providers, Scope of Appointment forms (SOAs), dependents, and custom fields.", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/GetV2CustomersIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/customers/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdPositiveResponse" } } } }, "400": { "description": "GET /v2/customers/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/customers/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/customers/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/customers/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/customers/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/customers/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/customers/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/customers/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/customers/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/customers/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2CustomersId", "summary": "Update customer by ID", "description": "Change a customer's details.", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdParameterId" } } ], "requestBody": { "description": "PATCH /v2/customers/:id Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/customers/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/customers/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/customers/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/customers/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/customers/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/customers/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/customers/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/customers/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/customers/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/customers/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/customers/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2CustomersIdNegativeResponse503" } } } } } } }, "/v2/customers": { "get": { "operationId": "GetV2Customers", "summary": "Get paginated list of customers", "description": "List your customers. You can filter and search, and results come back one page at a time.", "tags": [ "Customers" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "GET /v2/customers Parameter", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterPage" } }, { "name": "perPage", "in": "query", "required": false, "description": "GET /v2/customers Parameter", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterPerPage" } }, { "name": "sortBy", "in": "query", "required": false, "description": "Field to sort by", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterSortBy" } }, { "name": "sortDirection", "in": "query", "required": false, "description": "Sort direction", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterSortDirection" } }, { "name": "customFieldKeys", "in": "query", "required": false, "description": "GET /v2/customers Parameter", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterCustomFieldKeys" } }, { "name": "search", "in": "query", "required": false, "description": "Search query for filtering customers by customer ID, client customer ID, name, phone, email, ZIP code, MBI, or policy enrollment code.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterSearch" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated list of columns whose displayed text the search also matches: location, source, tags, campaigns, planName, carrierName, policyStatus, or customField: for a text, select, or multi-select custom field. Location matches a full state name; the others need a search of 3+ characters. Unknown entries are ignored.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterSearchFields" } }, { "name": "includeTestNumbers", "in": "query", "required": false, "description": "Include test phone numbers in results", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterIncludeTestNumbers" } }, { "name": "sourceIds", "in": "query", "required": false, "description": "Filter customers by source IDs (comma-separated)", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterSourceIds" } }, { "name": "tagIds", "in": "query", "required": false, "description": "Filter customers by known tag IDs (comma-separated, OR logic)", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterTagIds" } }, { "name": "campaignIds", "in": "query", "required": false, "description": "Filter customers by campaign IDs (comma-separated, OR logic)", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterCampaignIds" } }, { "name": "campaignIdMatchMode", "in": "query", "required": false, "description": "How campaignIds is matched. 'include' (default): customers enrolled in any of the campaigns, in any status. 'exclude': customers who have NEVER been enrolled in any of the campaigns (no customerCampaign row for them, in any status) - use to target the book that has not yet touched a campaign.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterCampaignIdMatchMode" } }, { "name": "campaignStatuses", "in": "query", "required": false, "description": "Filter customers by customerCampaign status (comma-separated, OR logic - matches if customer has any of these statuses in any campaign)", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterCampaignStatuses" } }, { "name": "campaignAttemptState", "in": "query", "required": false, "description": "Filter campaign customers by whether they have prior attempts", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterCampaignAttemptState" } }, { "name": "campaignFailureReason", "in": "query", "required": false, "description": "Filter customers by their customerCampaign canonical failure reason code (comma-separated, OR logic). Use with campaignIds to drill into a single campaign's exit reason.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterCampaignFailureReason" } }, { "name": "pulseNodeId", "in": "query", "required": false, "description": "Filter customers by their current Pulse node ID", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterPulseNodeId" } }, { "name": "policyStatuses", "in": "query", "required": false, "description": "Filter customers by policy status (comma-separated, OR logic). Valid values: Active, Placed, Pending, Pending Effectuation, Pending Followup, Suspended, Cancelled, Terminated, Future Cancel, Deceased, Not Approved", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterPolicyStatuses" } }, { "name": "coverageState", "in": "query", "required": false, "description": "Exclude customers with active coverage, or with active/pending coverage", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterCoverageState" } }, { "name": "assignedToMemberIds", "in": "query", "required": false, "description": "Filter customers by assigned member IDs (comma-separated, OR logic). Use 'unassigned' to filter customers with no assignee.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterAssignedToMemberIds" } }, { "name": "customerStatuses", "in": "query", "required": false, "description": "Filter customers by customer status (comma-separated, OR logic). Valid values: Lead, Active, Inactive", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterCustomerStatuses" } }, { "name": "dateField", "in": "query", "required": false, "description": "Which date the startDate/endDate range filters on: customer creation, or a policy date. Policy-derived conditions in the request must all match the same policy.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterDateField" } }, { "name": "startDate", "in": "query", "required": false, "description": "Inclusive start bound per dateField: YYYY-MM-DD at UTC midnight or an exact ISO timestamp. Policy DATE values represent UTC midnight.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "End bound per dateField. YYYY-MM-DD includes that UTC calendar day; a full ISO timestamp is exact and exclusive.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterEndDate" } }, { "name": "lastCallStartDate", "in": "query", "required": false, "description": "Inclusive call start bound: YYYY-MM-DD at UTC midnight or an exact ISO timestamp.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterLastCallStartDate" } }, { "name": "lastCallEndDate", "in": "query", "required": false, "description": "Call end bound. YYYY-MM-DD includes that UTC calendar day; a full ISO timestamp is exact and exclusive.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterLastCallEndDate" } }, { "name": "lastCallDispositions", "in": "query", "required": false, "description": "Filter customers by the disposition of their most recent call (comma-separated, OR logic). Calls with system error dispositions are ignored, matching the list's Last Contact column.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterLastCallDispositions" } }, { "name": "negatedFilters", "in": "query", "required": false, "description": "List filters to invert, comma-separated (campaignStatuses, lastCallDispositions). campaignStatuses: customers with NO enrollment in those statuses (scoped to campaignIds in include mode, so campaignIds=X&campaignStatuses=completed&negatedFilters=campaignStatuses is \"in campaign X and not completed there\"). lastCallDispositions: customers whose last call has none of them, including customers never called.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterNegatedFilters" } }, { "name": "contactPermissions", "in": "query", "required": false, "description": "Contact permission conditions, comma-separated and ANDed (can_call, do_not_call, can_text, do_not_text). A suppressed customer counts as both do_not_call and do_not_text, matching the list's icons.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterContactPermissions" } }, { "name": "totalCalls", "in": "query", "required": false, "description": "Compare the customer's call count, counted like the list's Total Calls column: operator:count (eq, neq, gt, gte, lt, lte), or between:min:max (inclusive). Example: gte:2.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterTotalCalls" } }, { "name": "states", "in": "query", "required": false, "description": "Filter customers by US state (comma-separated, OR logic)", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterStates" } }, { "name": "counties", "in": "query", "required": false, "description": "Filter customers by county (comma-separated, OR logic)", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterCounties" } }, { "name": "policyTypes", "in": "query", "required": false, "description": "Filter customers who have a policy of any of these types (comma-separated, OR logic). Valid values: MA, MAPD, PDP, MS, ACA, LTC, Individual Health, FE, Annuity, Life, Dental, Vision, Hospital Indemnity, Cancer, Critical Illness, Accident, Group, Home Health Care, International Travel", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterPolicyTypes" } }, { "name": "turning65Window", "in": "query", "required": false, "description": "Filter customers whose 65th birthday falls within the next 3/6/12 months (Medicare aging-in)", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterTurning65Window" } }, { "name": "subsidyOperator", "in": "query", "required": false, "description": "Comparison for the policy subsidy amount filter. Requires subsidyValue (and subsidyValueTo when 'between').", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterSubsidyOperator" } }, { "name": "subsidyValue", "in": "query", "required": false, "description": "Subsidy amount to compare against (dollars). For 'between', this is the lower bound.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterSubsidyValue" } }, { "name": "subsidyValueTo", "in": "query", "required": false, "description": "Upper bound for the 'between' subsidy comparison.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterSubsidyValueTo" } }, { "name": "customFieldFilters", "in": "query", "required": false, "description": "Filter customers by custom field values (ANDed). JSON array of { key, operator, value? }. Operators: eq, neq, gt, gte, lt, lte, is_empty, is_not_empty.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterCustomFieldFilters" } }, { "name": "sortCustomFieldKey", "in": "query", "required": false, "description": "When set, sort by this custom field's value (key from GET /v2/custom-fields) using sortDirection, overriding sortBy.", "schema": { "$ref": "#/components/schemas/GetV2CustomersParameterSortCustomFieldKey" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/customers Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersPositiveResponse" } } } }, "400": { "description": "GET /v2/customers Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersNegativeResponse400" } } } }, "401": { "description": "GET /v2/customers Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersNegativeResponse401" } } } }, "403": { "description": "GET /v2/customers Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersNegativeResponse403" } } } }, "404": { "description": "GET /v2/customers Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersNegativeResponse404" } } } }, "409": { "description": "GET /v2/customers Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersNegativeResponse409" } } } }, "422": { "description": "GET /v2/customers Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersNegativeResponse422" } } } }, "429": { "description": "GET /v2/customers Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersNegativeResponse429" } } } }, "500": { "description": "GET /v2/customers Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersNegativeResponse500" } } } }, "502": { "description": "GET /v2/customers Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersNegativeResponse502" } } } }, "503": { "description": "GET /v2/customers Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomersNegativeResponse503" } } } } } }, "post": { "operationId": "PostV2Customers", "summary": "Create customer", "description": "Add a new customer. Each customer needs a phone number that no other customer in your organization has.", "tags": [ "Customers" ], "requestBody": { "description": "POST /v2/customers Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/customers Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersPositiveResponse" } } } }, "400": { "description": "POST /v2/customers Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersNegativeResponse400" } } } }, "401": { "description": "POST /v2/customers Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersNegativeResponse401" } } } }, "403": { "description": "POST /v2/customers Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersNegativeResponse403" } } } }, "404": { "description": "POST /v2/customers Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersNegativeResponse404" } } } }, "409": { "description": "POST /v2/customers Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersNegativeResponse409" } } } }, "422": { "description": "POST /v2/customers Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersNegativeResponse422" } } } }, "429": { "description": "POST /v2/customers Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersNegativeResponse429" } } } }, "500": { "description": "POST /v2/customers Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersNegativeResponse500" } } } }, "502": { "description": "POST /v2/customers Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersNegativeResponse502" } } } }, "503": { "description": "POST /v2/customers Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomersNegativeResponse503" } } } } } } }, "/v2/inquiries/{id}": { "get": { "operationId": "GetV2InquiriesId", "summary": "Get inquiry by id", "description": "Look up one inquiry by its ID. An inquiry is a caller's question or request that your team needs to follow up on.", "tags": [ "Inquiries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Inquiry ID", "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/inquiries/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdPositiveResponse" } } } }, "400": { "description": "GET /v2/inquiries/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/inquiries/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/inquiries/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/inquiries/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/inquiries/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/inquiries/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/inquiries/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/inquiries/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/inquiries/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/inquiries/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2InquiriesId", "summary": "Update inquiry by id", "description": "Change an inquiry, for example to update its status.", "tags": [ "Inquiries" ], "parameters": [ { "name": "id", "in": "path", "required": false, "description": "PATCH /v2/inquiries/:id Parameter", "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdParameterId" } } ], "requestBody": { "description": "PATCH /v2/inquiries/:id Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/inquiries/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/inquiries/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/inquiries/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/inquiries/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/inquiries/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/inquiries/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/inquiries/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/inquiries/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/inquiries/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/inquiries/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/inquiries/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2InquiriesIdNegativeResponse503" } } } } } } }, "/v2/inquiries": { "get": { "operationId": "GetV2Inquiries", "summary": "List inquiries", "description": "List inquiries: questions or requests from callers that your team needs to follow up on. You can filter by status.", "tags": [ "Inquiries" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "GET /v2/inquiries Parameter", "schema": { "$ref": "#/components/schemas/GetV2InquiriesParameterPage" } }, { "name": "perPage", "in": "query", "required": false, "description": "GET /v2/inquiries Parameter", "schema": { "$ref": "#/components/schemas/GetV2InquiriesParameterPerPage" } }, { "name": "status", "in": "query", "required": false, "description": "Filter inquiries by status. Single value or comma-separated list (e.g. 'new' or 'new,pending_resolution,unresolved')", "schema": { "$ref": "#/components/schemas/GetV2InquiriesParameterStatus" } }, { "name": "agentName", "in": "query", "required": false, "description": "Filter inquiries by agent name", "schema": { "$ref": "#/components/schemas/GetV2InquiriesParameterAgentName" } }, { "name": "assignedTo", "in": "query", "required": false, "description": "Filter inquiries by assigned user. Single user id or comma-separated list of user ids.", "schema": { "$ref": "#/components/schemas/GetV2InquiriesParameterAssignedTo" } }, { "name": "priority", "in": "query", "required": false, "description": "Filter to one priority tier, or 'none' for unscored inquiries", "schema": { "$ref": "#/components/schemas/GetV2InquiriesParameterPriority" } }, { "name": "customerId", "in": "query", "required": false, "description": "Filter inquiries to a single customer", "schema": { "$ref": "#/components/schemas/GetV2InquiriesParameterCustomerId" } }, { "name": "search", "in": "query", "required": false, "description": "Search inquiries by customer name or phone number", "schema": { "$ref": "#/components/schemas/GetV2InquiriesParameterSearch" } }, { "name": "sortBy", "in": "query", "required": false, "description": "Column to sort by. Supported: 'createdAt' (default), 'priority'. Unknown values fall back to createdAt.", "schema": { "$ref": "#/components/schemas/GetV2InquiriesParameterSortBy" } }, { "name": "sortDirection", "in": "query", "required": false, "description": "Sort direction, defaults to desc. For 'priority', direction describes urgency: desc = most urgent (P1) first.", "schema": { "$ref": "#/components/schemas/GetV2InquiriesParameterSortDirection" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/inquiries Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesPositiveResponse" } } } }, "400": { "description": "GET /v2/inquiries Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesNegativeResponse400" } } } }, "401": { "description": "GET /v2/inquiries Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesNegativeResponse401" } } } }, "403": { "description": "GET /v2/inquiries Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesNegativeResponse403" } } } }, "404": { "description": "GET /v2/inquiries Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesNegativeResponse404" } } } }, "409": { "description": "GET /v2/inquiries Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesNegativeResponse409" } } } }, "422": { "description": "GET /v2/inquiries Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesNegativeResponse422" } } } }, "429": { "description": "GET /v2/inquiries Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesNegativeResponse429" } } } }, "500": { "description": "GET /v2/inquiries Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesNegativeResponse500" } } } }, "502": { "description": "GET /v2/inquiries Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesNegativeResponse502" } } } }, "503": { "description": "GET /v2/inquiries Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2InquiriesNegativeResponse503" } } } } } } }, "/v2/sources/performance": { "get": { "operationId": "GetV2SourcesPerformance", "summary": "Get source performance metrics for a campaign", "description": "See how well each lead source is doing in a campaign.", "tags": [ "Sources" ], "parameters": [ { "name": "campaignId", "in": "query", "required": false, "description": "GET /v2/sources/performance Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceParameterCampaignId" } }, { "name": "startDate", "in": "query", "required": false, "description": "GET /v2/sources/performance Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "GET /v2/sources/performance Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceParameterEndDate" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/sources/performance Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformancePositiveResponse" } } } }, "400": { "description": "GET /v2/sources/performance Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceNegativeResponse400" } } } }, "401": { "description": "GET /v2/sources/performance Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceNegativeResponse401" } } } }, "403": { "description": "GET /v2/sources/performance Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceNegativeResponse403" } } } }, "404": { "description": "GET /v2/sources/performance Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceNegativeResponse404" } } } }, "409": { "description": "GET /v2/sources/performance Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceNegativeResponse409" } } } }, "422": { "description": "GET /v2/sources/performance Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceNegativeResponse422" } } } }, "429": { "description": "GET /v2/sources/performance Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceNegativeResponse429" } } } }, "500": { "description": "GET /v2/sources/performance Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceNegativeResponse500" } } } }, "502": { "description": "GET /v2/sources/performance Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceNegativeResponse502" } } } }, "503": { "description": "GET /v2/sources/performance Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPerformanceNegativeResponse503" } } } } } } }, "/v2/sources/pings": { "get": { "operationId": "GetV2SourcesPings", "summary": "List ping activity", "description": "See ping-post activity for your sources: totals, a chart over time, and each ping. The chart is hourly for windows up to 3 days and daily after that, and pings come back one page at a time. Covers the last 7 days unless you pick dates. Caller IDs and qualification fields on failed pings are redacted after the retention window.", "tags": [ "Sources" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "GET /v2/sources/pings Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsParameterPage" } }, { "name": "perPage", "in": "query", "required": false, "description": "GET /v2/sources/pings Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsParameterPerPage" } }, { "name": "sourceId", "in": "query", "required": false, "description": "Source filter: accepts the public source ID or the internal source UUID. Unknown values return an empty result rather than an error.", "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsParameterSourceId" } }, { "name": "campaignId", "in": "query", "required": false, "description": "GET /v2/sources/pings Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsParameterCampaignId" } }, { "name": "startDate", "in": "query", "required": false, "description": "GET /v2/sources/pings Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsParameterStartDate" } }, { "name": "endDate", "in": "query", "required": false, "description": "GET /v2/sources/pings Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsParameterEndDate" } }, { "name": "availability", "in": "query", "required": false, "description": "Filter by the availability answered to the vendor", "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsParameterAvailability" } }, { "name": "status", "in": "query", "required": false, "description": "GET /v2/sources/pings Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsParameterStatus" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/sources/pings Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsPositiveResponse" } } } }, "400": { "description": "GET /v2/sources/pings Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsNegativeResponse400" } } } }, "401": { "description": "GET /v2/sources/pings Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsNegativeResponse401" } } } }, "403": { "description": "GET /v2/sources/pings Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsNegativeResponse403" } } } }, "404": { "description": "GET /v2/sources/pings Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsNegativeResponse404" } } } }, "409": { "description": "GET /v2/sources/pings Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsNegativeResponse409" } } } }, "422": { "description": "GET /v2/sources/pings Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsNegativeResponse422" } } } }, "429": { "description": "GET /v2/sources/pings Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsNegativeResponse429" } } } }, "500": { "description": "GET /v2/sources/pings Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsNegativeResponse500" } } } }, "502": { "description": "GET /v2/sources/pings Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsNegativeResponse502" } } } }, "503": { "description": "GET /v2/sources/pings Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPingsNegativeResponse503" } } } } } } }, "/v2/sources/{id}/assignments": { "get": { "operationId": "GetV2SourcesIdAssignments", "summary": "List campaign assignments for a source", "description": "List the campaigns a lead source is connected to.", "tags": [ "Sources" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v2/sources/:id/assignments Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/sources/:id/assignments Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsPositiveResponse" } } } }, "400": { "description": "GET /v2/sources/:id/assignments Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsNegativeResponse400" } } } }, "401": { "description": "GET /v2/sources/:id/assignments Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsNegativeResponse401" } } } }, "403": { "description": "GET /v2/sources/:id/assignments Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsNegativeResponse403" } } } }, "404": { "description": "GET /v2/sources/:id/assignments Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsNegativeResponse404" } } } }, "409": { "description": "GET /v2/sources/:id/assignments Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsNegativeResponse409" } } } }, "422": { "description": "GET /v2/sources/:id/assignments Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsNegativeResponse422" } } } }, "429": { "description": "GET /v2/sources/:id/assignments Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsNegativeResponse429" } } } }, "500": { "description": "GET /v2/sources/:id/assignments Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsNegativeResponse500" } } } }, "502": { "description": "GET /v2/sources/:id/assignments Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsNegativeResponse502" } } } }, "503": { "description": "GET /v2/sources/:id/assignments Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdAssignmentsNegativeResponse503" } } } } } }, "post": { "operationId": "PostV2SourcesIdAssignments", "summary": "Assign a source to a campaign", "description": "Connect a lead source to a campaign. Choose how leads arrive (the acquisition type) and, if you want, an existing tracking number. Connecting the same source again keeps its current setup and number. The campaign still decides how calls are handled.", "tags": [ "Sources" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "POST /v2/sources/:id/assignments Parameter", "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsParameterId" } } ], "requestBody": { "description": "POST /v2/sources/:id/assignments Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/sources/:id/assignments Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsPositiveResponse" } } } }, "400": { "description": "POST /v2/sources/:id/assignments Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsNegativeResponse400" } } } }, "401": { "description": "POST /v2/sources/:id/assignments Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsNegativeResponse401" } } } }, "403": { "description": "POST /v2/sources/:id/assignments Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsNegativeResponse403" } } } }, "404": { "description": "POST /v2/sources/:id/assignments Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsNegativeResponse404" } } } }, "409": { "description": "POST /v2/sources/:id/assignments Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsNegativeResponse409" } } } }, "422": { "description": "POST /v2/sources/:id/assignments Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsNegativeResponse422" } } } }, "429": { "description": "POST /v2/sources/:id/assignments Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsNegativeResponse429" } } } }, "500": { "description": "POST /v2/sources/:id/assignments Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsNegativeResponse500" } } } }, "502": { "description": "POST /v2/sources/:id/assignments Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsNegativeResponse502" } } } }, "503": { "description": "POST /v2/sources/:id/assignments Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesIdAssignmentsNegativeResponse503" } } } } } } }, "/v2/sources/{id}": { "get": { "operationId": "GetV2SourcesId", "summary": "Get source by ID", "description": "Look up one lead source by its ID.", "tags": [ "Sources" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v2/sources/:id Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/sources/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdPositiveResponse" } } } }, "400": { "description": "GET /v2/sources/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/sources/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/sources/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/sources/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/sources/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/sources/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/sources/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/sources/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/sources/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/sources/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesIdNegativeResponse503" } } } } } }, "patch": { "operationId": "PatchV2SourcesId", "summary": "Update an existing source", "description": "Change a lead source's settings. Price changes only apply from now on. Past charges keep the amount they had when they happened, so old reports don't change.", "tags": [ "Sources" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "PATCH /v2/sources/:id Parameter", "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdParameterId" } } ], "requestBody": { "description": "PATCH /v2/sources/:id Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/sources/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/sources/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/sources/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/sources/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/sources/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/sources/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/sources/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/sources/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/sources/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/sources/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/sources/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourcesIdNegativeResponse503" } } } } } }, "delete": { "operationId": "DeleteV2SourcesId", "summary": "Delete an existing source", "description": "Remove a lead source.", "tags": [ "Sources" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "DELETE /v2/sources/:id Parameter", "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/sources/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/sources/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/sources/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/sources/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/sources/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/sources/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/sources/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/sources/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/sources/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/sources/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/sources/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SourcesIdNegativeResponse503" } } } } } } }, "/v2/sources": { "get": { "operationId": "GetV2Sources", "summary": "List all sources", "description": "List your lead sources: the vendors and channels your leads and calls come from. Results come back one page at a time.", "tags": [ "Sources" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "GET /v2/sources Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesParameterPage" } }, { "name": "perPage", "in": "query", "required": false, "description": "GET /v2/sources Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesParameterPerPage" } }, { "name": "search", "in": "query", "required": false, "description": "GET /v2/sources Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesParameterSearch" } }, { "name": "enabled", "in": "query", "required": false, "description": "GET /v2/sources Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesParameterEnabled" } }, { "name": "dealType", "in": "query", "required": false, "description": "GET /v2/sources Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesParameterDealType" } }, { "name": "campaignId", "in": "query", "required": false, "description": "GET /v2/sources Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesParameterCampaignId" } }, { "name": "direction", "in": "query", "required": false, "description": "GET /v2/sources Parameter", "schema": { "$ref": "#/components/schemas/GetV2SourcesParameterDirection" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/sources Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesPositiveResponse" } } } }, "400": { "description": "GET /v2/sources Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesNegativeResponse400" } } } }, "401": { "description": "GET /v2/sources Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesNegativeResponse401" } } } }, "403": { "description": "GET /v2/sources Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesNegativeResponse403" } } } }, "404": { "description": "GET /v2/sources Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesNegativeResponse404" } } } }, "409": { "description": "GET /v2/sources Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesNegativeResponse409" } } } }, "422": { "description": "GET /v2/sources Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesNegativeResponse422" } } } }, "429": { "description": "GET /v2/sources Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesNegativeResponse429" } } } }, "500": { "description": "GET /v2/sources Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesNegativeResponse500" } } } }, "502": { "description": "GET /v2/sources Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesNegativeResponse502" } } } }, "503": { "description": "GET /v2/sources Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SourcesNegativeResponse503" } } } } } }, "post": { "operationId": "PostV2Sources", "summary": "Create a new source", "description": "Create a lead source to track where leads and calls come from. You can connect it to a campaign at the same time. Enabled live-call assignments require an existing campaign-owned tracking number; this operation never purchases numbers. Set createPingPostKey to explicitly request a one-time source-scoped vendor key.", "tags": [ "Sources" ], "requestBody": { "description": "POST /v2/sources Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/sources Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesPositiveResponse" } } } }, "400": { "description": "POST /v2/sources Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesNegativeResponse400" } } } }, "401": { "description": "POST /v2/sources Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesNegativeResponse401" } } } }, "403": { "description": "POST /v2/sources Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesNegativeResponse403" } } } }, "404": { "description": "POST /v2/sources Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesNegativeResponse404" } } } }, "409": { "description": "POST /v2/sources Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesNegativeResponse409" } } } }, "422": { "description": "POST /v2/sources Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesNegativeResponse422" } } } }, "429": { "description": "POST /v2/sources Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesNegativeResponse429" } } } }, "500": { "description": "POST /v2/sources Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesNegativeResponse500" } } } }, "502": { "description": "POST /v2/sources Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesNegativeResponse502" } } } }, "503": { "description": "POST /v2/sources Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SourcesNegativeResponse503" } } } } } } }, "/v2/source-assignments/{id}": { "patch": { "operationId": "PatchV2SourceAssignmentsId", "summary": "Update a source campaign assignment", "description": "Change how a lead source is set up for one campaign.", "tags": [ "Sources" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "PATCH /v2/source-assignments/:id Parameter", "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdParameterId" } } ], "requestBody": { "description": "PATCH /v2/source-assignments/:id Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PATCH /v2/source-assignments/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdPositiveResponse" } } } }, "400": { "description": "PATCH /v2/source-assignments/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdNegativeResponse400" } } } }, "401": { "description": "PATCH /v2/source-assignments/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdNegativeResponse401" } } } }, "403": { "description": "PATCH /v2/source-assignments/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdNegativeResponse403" } } } }, "404": { "description": "PATCH /v2/source-assignments/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdNegativeResponse404" } } } }, "409": { "description": "PATCH /v2/source-assignments/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdNegativeResponse409" } } } }, "422": { "description": "PATCH /v2/source-assignments/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdNegativeResponse422" } } } }, "429": { "description": "PATCH /v2/source-assignments/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdNegativeResponse429" } } } }, "500": { "description": "PATCH /v2/source-assignments/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdNegativeResponse500" } } } }, "502": { "description": "PATCH /v2/source-assignments/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdNegativeResponse502" } } } }, "503": { "description": "PATCH /v2/source-assignments/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchV2SourceAssignmentsIdNegativeResponse503" } } } } } } }, "/v2/custom-fields/{id}": { "get": { "operationId": "GetV2CustomFieldsId", "summary": "Get a custom field definition by ID", "description": "Look up one of your custom fields by its ID.", "tags": [ "Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Custom field definition ID", "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/custom-fields/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdPositiveResponse" } } } }, "400": { "description": "GET /v2/custom-fields/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdNegativeResponse400" } } } }, "401": { "description": "GET /v2/custom-fields/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdNegativeResponse401" } } } }, "403": { "description": "GET /v2/custom-fields/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdNegativeResponse403" } } } }, "404": { "description": "GET /v2/custom-fields/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdNegativeResponse404" } } } }, "409": { "description": "GET /v2/custom-fields/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdNegativeResponse409" } } } }, "422": { "description": "GET /v2/custom-fields/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdNegativeResponse422" } } } }, "429": { "description": "GET /v2/custom-fields/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdNegativeResponse429" } } } }, "500": { "description": "GET /v2/custom-fields/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdNegativeResponse500" } } } }, "502": { "description": "GET /v2/custom-fields/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdNegativeResponse502" } } } }, "503": { "description": "GET /v2/custom-fields/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsIdNegativeResponse503" } } } } } }, "put": { "operationId": "PutV2CustomFieldsId", "summary": "Update a custom field definition", "description": "Change a custom field's settings, like its name or type.", "tags": [ "Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Custom field definition ID", "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdParameterId" } } ], "requestBody": { "description": "PUT /v2/custom-fields/:id Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdRequestBody" } } } }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "PUT /v2/custom-fields/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdPositiveResponse" } } } }, "400": { "description": "PUT /v2/custom-fields/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdNegativeResponse400" } } } }, "401": { "description": "PUT /v2/custom-fields/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdNegativeResponse401" } } } }, "403": { "description": "PUT /v2/custom-fields/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdNegativeResponse403" } } } }, "404": { "description": "PUT /v2/custom-fields/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdNegativeResponse404" } } } }, "409": { "description": "PUT /v2/custom-fields/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdNegativeResponse409" } } } }, "422": { "description": "PUT /v2/custom-fields/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdNegativeResponse422" } } } }, "429": { "description": "PUT /v2/custom-fields/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdNegativeResponse429" } } } }, "500": { "description": "PUT /v2/custom-fields/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdNegativeResponse500" } } } }, "502": { "description": "PUT /v2/custom-fields/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdNegativeResponse502" } } } }, "503": { "description": "PUT /v2/custom-fields/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutV2CustomFieldsIdNegativeResponse503" } } } } } }, "delete": { "operationId": "DeleteV2CustomFieldsId", "summary": "Delete a custom field definition", "description": "Remove a custom field you've set up.", "tags": [ "Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Custom field definition ID", "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/custom-fields/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/custom-fields/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/custom-fields/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/custom-fields/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/custom-fields/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/custom-fields/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/custom-fields/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/custom-fields/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/custom-fields/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/custom-fields/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/custom-fields/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2CustomFieldsIdNegativeResponse503" } } } } } } }, "/v2/custom-fields": { "get": { "operationId": "GetV2CustomFields", "summary": "List custom fields", "description": "List the custom fields you've set up to store extra details on customers and policies. Results come back one page at a time.", "tags": [ "Custom Fields" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "GET /v2/custom-fields Parameter", "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsParameterPage" } }, { "name": "perPage", "in": "query", "required": false, "description": "GET /v2/custom-fields Parameter", "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsParameterPerPage" } }, { "name": "recordType", "in": "query", "required": false, "description": "Filter by record type", "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsParameterRecordType" } }, { "name": "sortBy", "in": "query", "required": false, "description": "Field to sort by", "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsParameterSortBy" } }, { "name": "sortDirection", "in": "query", "required": false, "description": "Sort direction", "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsParameterSortDirection" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/custom-fields Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsPositiveResponse" } } } }, "400": { "description": "GET /v2/custom-fields Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsNegativeResponse400" } } } }, "401": { "description": "GET /v2/custom-fields Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsNegativeResponse401" } } } }, "403": { "description": "GET /v2/custom-fields Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsNegativeResponse403" } } } }, "404": { "description": "GET /v2/custom-fields Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsNegativeResponse404" } } } }, "409": { "description": "GET /v2/custom-fields Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsNegativeResponse409" } } } }, "422": { "description": "GET /v2/custom-fields Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsNegativeResponse422" } } } }, "429": { "description": "GET /v2/custom-fields Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsNegativeResponse429" } } } }, "500": { "description": "GET /v2/custom-fields Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsNegativeResponse500" } } } }, "502": { "description": "GET /v2/custom-fields Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsNegativeResponse502" } } } }, "503": { "description": "GET /v2/custom-fields Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2CustomFieldsNegativeResponse503" } } } } } }, "post": { "operationId": "PostV2CustomFields", "summary": "Create a new custom field definition", "description": "Set up a new custom field to store extra details on customers or policies.", "tags": [ "Custom Fields" ], "requestBody": { "description": "POST /v2/custom-fields Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/custom-fields Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsPositiveResponse" } } } }, "400": { "description": "POST /v2/custom-fields Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsNegativeResponse400" } } } }, "401": { "description": "POST /v2/custom-fields Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsNegativeResponse401" } } } }, "403": { "description": "POST /v2/custom-fields Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsNegativeResponse403" } } } }, "404": { "description": "POST /v2/custom-fields Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsNegativeResponse404" } } } }, "409": { "description": "POST /v2/custom-fields Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsNegativeResponse409" } } } }, "422": { "description": "POST /v2/custom-fields Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsNegativeResponse422" } } } }, "429": { "description": "POST /v2/custom-fields Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsNegativeResponse429" } } } }, "500": { "description": "POST /v2/custom-fields Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsNegativeResponse500" } } } }, "502": { "description": "POST /v2/custom-fields Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsNegativeResponse502" } } } }, "503": { "description": "POST /v2/custom-fields Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2CustomFieldsNegativeResponse503" } } } } } } }, "/v2/sync/aca": { "post": { "operationId": "PostV2SyncAca", "summary": "Sync ACA customers and policies", "description": "Create or update ACA customers and their policies in one request.\n\n**Customer matching** (first identifier present wins): `healthSherpaCustomerId` → `externalId` → `carrierAssignedCustomerId` → fallback on `firstName` + `lastName` + `dateOfBirth` + `phoneNumber`.\n\n**Policy matching**: `healthSherpaPolicyId`, then `carrierAssignedPolicyId`.\n\n**Custom fields**: Put customer values in `records[].customFields` and policy values in `records[].policies[].customFields`. Each entry uses a configured `fieldKey` and `value`. Find keys in [Customer Custom Fields](https://app.carecycle.ai/settings/crm-settings/custom-fields/customer) and [Policy Custom Fields](https://app.carecycle.ai/settings/crm-settings/custom-fields/policy). Policy values are attached to the policy created or matched by the containing policy object.\n\nWhen a new policy is created, the customer's existing ACA policies with an `effectiveDate` more than one year old are terminated. `policyType` is always set to `ACA`.\n\n**Response**: For each successfully synced record, `results` contains the full customer record (same shape as the `customer.created`/`customer.updated` webhook) along with the policies this request changed: those created or updated from the request, plus any older policies auto-terminated as a side effect. The customer's untouched existing policies are not returned. Each returned policy carries a `previousStatus` field (its status before this request, or `null` if newly created); compare it with the policy's `status` to detect a flip; e.g. an auto-terminated policy comes back with `previousStatus: \"Active\"` and `status: \"Terminated\"`.", "tags": [ "Sync", "ACA" ], "requestBody": { "description": "POST /v2/sync/aca Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/sync/aca Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaPositiveResponse" } } } }, "400": { "description": "POST /v2/sync/aca Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaNegativeResponse400" } } } }, "401": { "description": "POST /v2/sync/aca Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaNegativeResponse401" } } } }, "403": { "description": "POST /v2/sync/aca Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaNegativeResponse403" } } } }, "404": { "description": "POST /v2/sync/aca Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaNegativeResponse404" } } } }, "409": { "description": "POST /v2/sync/aca Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaNegativeResponse409" } } } }, "422": { "description": "POST /v2/sync/aca Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaNegativeResponse422" } } } }, "429": { "description": "POST /v2/sync/aca Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaNegativeResponse429" } } } }, "500": { "description": "POST /v2/sync/aca Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaNegativeResponse500" } } } }, "502": { "description": "POST /v2/sync/aca Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaNegativeResponse502" } } } }, "503": { "description": "POST /v2/sync/aca Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncAcaNegativeResponse503" } } } } } } }, "/v2/sync/medicare": { "post": { "operationId": "PostV2SyncMedicare", "summary": "Sync Medicare customers and policies", "description": "Create or update Medicare customers and their policies in one request.\n\n**Customer matching**: `mbiNumber` first, then a fallback on `firstName` + `lastName` + `dateOfBirth` + `phoneNumber`. When a customer is matched via the fallback, their `mbiNumber` is backfilled from the request.\n\n**Policy matching**: `sunFireEnrollmentCode` first, then the `planCode` + `effectiveDate` composite.\n\n**Custom fields**: Put customer values in `records[].customFields` and policy values in `records[].policies[].customFields`. Each entry uses a configured `fieldKey` and `value`. Find keys in [Customer Custom Fields](https://app.carecycle.ai/settings/crm-settings/custom-fields/customer) and [Policy Custom Fields](https://app.carecycle.ai/settings/crm-settings/custom-fields/policy). Policy values are attached to the policy created or matched by the containing policy object.\n\n**Medicare plan codes**: For `MA` and `MAPD`, `planCode` must be a CMS contract-style code starting with `H` or `R`. For `PDP`, it must start with `S`, `H`, `R`, `E`, or `X`. The three-digit segment is optional: send contract+plan only (`H3146-036`) and careCycle infers the segment from CMS reference data, defaulting to `-000` for non-segmented plans; a record is rejected only when the plan genuinely has multiple segments (include the segment to disambiguate). Dashes are optional in requests (`H1234001000` and `H1234-001-000` are accepted); careCycle stores the canonical dashed form. `MS` plan codes are carrier-specific and are not required to follow the CMS contract format.\n\nWhen a new policy is created, the customer's existing policies of the **same** `policyType` with an `effectiveDate` more than one year old are terminated.\n\n`policyType` must be one of `MA`, `MAPD`, `MS`, or `PDP`.\n\n**Response**: For each successfully synced record, `results` contains the full customer record (same shape as the `customer.created`/`customer.updated` webhook) along with the policies this request changed: those created or updated from the request, plus any older policies auto-terminated as a side effect. The customer's untouched existing policies are not returned. Each returned policy carries a `previousStatus` field (its status before this request, or `null` if newly created); compare it with the policy's `status` to detect a flip; e.g. an auto-terminated policy comes back with `previousStatus: \"Active\"` and `status: \"Terminated\"`.", "tags": [ "Sync", "Medicare" ], "requestBody": { "description": "POST /v2/sync/medicare Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/sync/medicare Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicarePositiveResponse" } } } }, "400": { "description": "POST /v2/sync/medicare Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareNegativeResponse400" } } } }, "401": { "description": "POST /v2/sync/medicare Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareNegativeResponse401" } } } }, "403": { "description": "POST /v2/sync/medicare Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareNegativeResponse403" } } } }, "404": { "description": "POST /v2/sync/medicare Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareNegativeResponse404" } } } }, "409": { "description": "POST /v2/sync/medicare Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareNegativeResponse409" } } } }, "422": { "description": "POST /v2/sync/medicare Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareNegativeResponse422" } } } }, "429": { "description": "POST /v2/sync/medicare Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareNegativeResponse429" } } } }, "500": { "description": "POST /v2/sync/medicare Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareNegativeResponse500" } } } }, "502": { "description": "POST /v2/sync/medicare Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareNegativeResponse502" } } } }, "503": { "description": "POST /v2/sync/medicare Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SyncMedicareNegativeResponse503" } } } } } } }, "/v2/leads/upload": { "post": { "operationId": "PostV2LeadsUpload", "summary": "Upload lead records", "description": "Add new leads to careCycle. To track which source each lead came from, create the source in careCycle first, then pass sourceId and optional leadCost with each record.\n\n**Response**: For each successfully uploaded record, `results` contains the full customer record (same shape as the `customer.created`/`customer.updated` webhook). Lead upload does not handle policies, so no policies are returned; use `/v2/sync/aca` or `/v2/sync/medicare` for policies.", "tags": [ "Leads" ], "requestBody": { "description": "POST /v2/leads/upload Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/leads/upload Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadPositiveResponse" } } } }, "400": { "description": "POST /v2/leads/upload Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadNegativeResponse400" } } } }, "401": { "description": "POST /v2/leads/upload Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadNegativeResponse401" } } } }, "403": { "description": "POST /v2/leads/upload Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadNegativeResponse403" } } } }, "404": { "description": "POST /v2/leads/upload Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadNegativeResponse404" } } } }, "409": { "description": "POST /v2/leads/upload Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadNegativeResponse409" } } } }, "422": { "description": "POST /v2/leads/upload Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadNegativeResponse422" } } } }, "429": { "description": "POST /v2/leads/upload Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadNegativeResponse429" } } } }, "500": { "description": "POST /v2/leads/upload Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadNegativeResponse500" } } } }, "502": { "description": "POST /v2/leads/upload Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadNegativeResponse502" } } } }, "503": { "description": "POST /v2/leads/upload Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2LeadsUploadNegativeResponse503" } } } } } } }, "/v2/sandbox/calls/{callId}/status": { "get": { "operationId": "GetV2SandboxCallsCallIdStatus", "summary": "Get live status of a sandbox test call", "tags": [ "Sandbox" ], "parameters": [ { "name": "callId", "in": "path", "required": true, "description": "GET /v2/sandbox/calls/:callId/status Parameter", "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusParameterCallId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/sandbox/calls/:callId/status Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusPositiveResponse" } } } }, "400": { "description": "GET /v2/sandbox/calls/:callId/status Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusNegativeResponse400" } } } }, "401": { "description": "GET /v2/sandbox/calls/:callId/status Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusNegativeResponse401" } } } }, "403": { "description": "GET /v2/sandbox/calls/:callId/status Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusNegativeResponse403" } } } }, "404": { "description": "GET /v2/sandbox/calls/:callId/status Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusNegativeResponse404" } } } }, "409": { "description": "GET /v2/sandbox/calls/:callId/status Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusNegativeResponse409" } } } }, "422": { "description": "GET /v2/sandbox/calls/:callId/status Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusNegativeResponse422" } } } }, "429": { "description": "GET /v2/sandbox/calls/:callId/status Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusNegativeResponse429" } } } }, "500": { "description": "GET /v2/sandbox/calls/:callId/status Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusNegativeResponse500" } } } }, "502": { "description": "GET /v2/sandbox/calls/:callId/status Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusNegativeResponse502" } } } }, "503": { "description": "GET /v2/sandbox/calls/:callId/status Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxCallsCallIdStatusNegativeResponse503" } } } } } } }, "/v2/sandbox/calls": { "post": { "operationId": "PostV2SandboxCalls", "summary": "Initiate a sandbox outbound test call", "tags": [ "Sandbox" ], "requestBody": { "description": "POST /v2/sandbox/calls Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/sandbox/calls Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsPositiveResponse" } } } }, "400": { "description": "POST /v2/sandbox/calls Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsNegativeResponse400" } } } }, "401": { "description": "POST /v2/sandbox/calls Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsNegativeResponse401" } } } }, "403": { "description": "POST /v2/sandbox/calls Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsNegativeResponse403" } } } }, "404": { "description": "POST /v2/sandbox/calls Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsNegativeResponse404" } } } }, "409": { "description": "POST /v2/sandbox/calls Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsNegativeResponse409" } } } }, "422": { "description": "POST /v2/sandbox/calls Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsNegativeResponse422" } } } }, "429": { "description": "POST /v2/sandbox/calls Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsNegativeResponse429" } } } }, "500": { "description": "POST /v2/sandbox/calls Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsNegativeResponse500" } } } }, "502": { "description": "POST /v2/sandbox/calls Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsNegativeResponse502" } } } }, "503": { "description": "POST /v2/sandbox/calls Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxCallsNegativeResponse503" } } } } } } }, "/v2/sandbox/numbers/{id}": { "delete": { "operationId": "DeleteV2SandboxNumbersId", "summary": "Remove a test phone number", "tags": [ "Sandbox" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "DELETE /v2/sandbox/numbers/:id Parameter", "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdParameterId" } } ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "DELETE /v2/sandbox/numbers/:id Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdPositiveResponse" } } } }, "400": { "description": "DELETE /v2/sandbox/numbers/:id Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdNegativeResponse400" } } } }, "401": { "description": "DELETE /v2/sandbox/numbers/:id Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdNegativeResponse401" } } } }, "403": { "description": "DELETE /v2/sandbox/numbers/:id Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdNegativeResponse403" } } } }, "404": { "description": "DELETE /v2/sandbox/numbers/:id Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdNegativeResponse404" } } } }, "409": { "description": "DELETE /v2/sandbox/numbers/:id Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdNegativeResponse409" } } } }, "422": { "description": "DELETE /v2/sandbox/numbers/:id Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdNegativeResponse422" } } } }, "429": { "description": "DELETE /v2/sandbox/numbers/:id Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdNegativeResponse429" } } } }, "500": { "description": "DELETE /v2/sandbox/numbers/:id Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdNegativeResponse500" } } } }, "502": { "description": "DELETE /v2/sandbox/numbers/:id Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdNegativeResponse502" } } } }, "503": { "description": "DELETE /v2/sandbox/numbers/:id Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteV2SandboxNumbersIdNegativeResponse503" } } } } } } }, "/v2/sandbox/numbers": { "get": { "operationId": "GetV2SandboxNumbers", "summary": "List registered test phone numbers", "tags": [ "Sandbox" ], "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "GET /v2/sandbox/numbers Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersPositiveResponse" } } } }, "400": { "description": "GET /v2/sandbox/numbers Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersNegativeResponse400" } } } }, "401": { "description": "GET /v2/sandbox/numbers Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersNegativeResponse401" } } } }, "403": { "description": "GET /v2/sandbox/numbers Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersNegativeResponse403" } } } }, "404": { "description": "GET /v2/sandbox/numbers Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersNegativeResponse404" } } } }, "409": { "description": "GET /v2/sandbox/numbers Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersNegativeResponse409" } } } }, "422": { "description": "GET /v2/sandbox/numbers Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersNegativeResponse422" } } } }, "429": { "description": "GET /v2/sandbox/numbers Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersNegativeResponse429" } } } }, "500": { "description": "GET /v2/sandbox/numbers Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersNegativeResponse500" } } } }, "502": { "description": "GET /v2/sandbox/numbers Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersNegativeResponse502" } } } }, "503": { "description": "GET /v2/sandbox/numbers Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetV2SandboxNumbersNegativeResponse503" } } } } } }, "post": { "operationId": "PostV2SandboxNumbers", "summary": "Register a test phone number", "tags": [ "Sandbox" ], "requestBody": { "description": "POST /v2/sandbox/numbers Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/sandbox/numbers Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersPositiveResponse" } } } }, "400": { "description": "POST /v2/sandbox/numbers Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersNegativeResponse400" } } } }, "401": { "description": "POST /v2/sandbox/numbers Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersNegativeResponse401" } } } }, "403": { "description": "POST /v2/sandbox/numbers Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersNegativeResponse403" } } } }, "404": { "description": "POST /v2/sandbox/numbers Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersNegativeResponse404" } } } }, "409": { "description": "POST /v2/sandbox/numbers Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersNegativeResponse409" } } } }, "422": { "description": "POST /v2/sandbox/numbers Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersNegativeResponse422" } } } }, "429": { "description": "POST /v2/sandbox/numbers Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersNegativeResponse429" } } } }, "500": { "description": "POST /v2/sandbox/numbers Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersNegativeResponse500" } } } }, "502": { "description": "POST /v2/sandbox/numbers Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersNegativeResponse502" } } } }, "503": { "description": "POST /v2/sandbox/numbers Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2SandboxNumbersNegativeResponse503" } } } } } } }, "/v2/ping": { "post": { "operationId": "PostV2Ping", "summary": "Check availability before transferring a caller", "description": "Ask whether careCycle can take a live caller right now, before you transfer them. Returns whether the call can be taken right now (`agent_available`) and the tracking number to transfer the caller to (`number`).\n\nAvailability is a real check: live agent presence, business hours, AI coverage, and per-agent source blocks. When the ping includes `state` and the destination routes by agent licensure, availability also requires an agent licensed in that state (declined as `no_licensed_agents`).\n\nInclude any qualification data you have (name, date of birth, state, postal code, etc.) in the JSON body. It is stored with the ping and used to pre-fill the customer record when the call arrives. Unrecognized body fields are preserved as additional customer data.\n\nRequires an API key with the `ping-post` permission scoped to the pinged source (`x-api-key` header).", "tags": [ "Ping Post" ], "requestBody": { "description": "POST /v2/ping Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingRequestBody" } } }, "required": true }, "security": [ { "x-api-key": [] } ], "responses": { "200": { "description": "POST /v2/ping Positive response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingPositiveResponse" } } } }, "400": { "description": "POST /v2/ping Negative response 400", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingNegativeResponse400" } } } }, "401": { "description": "POST /v2/ping Negative response 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingNegativeResponse401" } } } }, "403": { "description": "POST /v2/ping Negative response 403", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingNegativeResponse403" } } } }, "404": { "description": "POST /v2/ping Negative response 404", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingNegativeResponse404" } } } }, "409": { "description": "POST /v2/ping Negative response 409", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingNegativeResponse409" } } } }, "422": { "description": "POST /v2/ping Negative response 422", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingNegativeResponse422" } } } }, "429": { "description": "POST /v2/ping Negative response 429", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingNegativeResponse429" } } } }, "500": { "description": "POST /v2/ping Negative response 500", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingNegativeResponse500" } } } }, "502": { "description": "POST /v2/ping Negative response 502", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingNegativeResponse502" } } } }, "503": { "description": "POST /v2/ping Negative response 503", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostV2PingNegativeResponse503" } } } } } } } }, "components": { "schemas": { "GetV2RoutingGroupsIdParameterId": { "description": "Transfer config ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2RoutingGroupsIdPositiveResponse": { "type": "object", "properties": { "transferConfig": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } }, "additionalProperties": false }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ], "additionalProperties": false } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Transfer config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Transfer config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "routingConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Routing config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Routing config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "routingType": { "type": "string", "enum": [ "linear", "balanced", "weighted", "grouped" ] }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fallbackBehavior": { "type": "string", "enum": [ "voicemail", "schedule_meeting", "transfer_to_number" ] }, "fallbackNumber": { "type": [ "string", "null" ], "maxLength": 20 }, "maxRingPerAgent": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxWaitTime": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "tryCustomerAgentFirst": { "type": [ "boolean", "null" ] }, "tryPreviousSoftphoneAgentFirst": { "type": [ "boolean", "null" ] }, "customerAgentPriority": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "previousSoftphoneAgentPriority": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "stateBasedRouting": { "type": [ "boolean", "null" ] }, "stateRoutingFallback": { "type": "string", "enum": [ "fallback", "all_agents" ] }, "agents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Routing agent creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Routing agent last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "routingConfigId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "memberId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "groupId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weight": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "lastCallAt": { "description": "Routing agent last call time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "isActive": { "type": [ "boolean", "null" ] }, "skills": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "member": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Member creation time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "role": { "type": "string" }, "removedAt": { "description": "Member removal time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "removedByUserId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "removedReason": { "type": [ "string", "null" ] }, "replacementMemberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "filterData": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "id", "name", "email" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "clientId", "userId", "role", "removedAt", "removedByUserId", "removedReason", "replacementMemberId", "filterData", "user" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "routingConfigId", "memberId", "groupId", "priority", "weight", "lastCallAt", "isActive", "skills" ], "additionalProperties": false } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Routing group creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Routing group last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "routingConfigId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "routingType": { "type": "string", "enum": [ "linear", "balanced", "weighted" ] }, "priority": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "isActive": { "type": [ "boolean", "null" ] }, "agents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Routing agent creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Routing agent last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "routingConfigId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "memberId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "groupId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weight": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "lastCallAt": { "description": "Routing agent last call time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "isActive": { "type": [ "boolean", "null" ] }, "skills": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "member": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Member creation time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "role": { "type": "string" }, "removedAt": { "description": "Member removal time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "removedByUserId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "removedReason": { "type": [ "string", "null" ] }, "replacementMemberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "filterData": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "id", "name", "email" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "clientId", "userId", "role", "removedAt", "removedByUserId", "removedReason", "replacementMemberId", "filterData", "user" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "routingConfigId", "memberId", "groupId", "priority", "weight", "lastCallAt", "isActive", "skills" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "routingConfigId", "name", "description", "routingType", "priority", "isActive", "agents" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "name", "description", "routingType", "clientId", "fallbackBehavior", "fallbackNumber", "maxRingPerAgent", "maxWaitTime", "tryCustomerAgentFirst", "tryPreviousSoftphoneAgentFirst", "customerAgentPriority", "previousSoftphoneAgentPriority", "stateBasedRouting", "stateRoutingFallback", "agents", "groups" ], "additionalProperties": false }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "compatibilityWarnings": { "default": [], "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "appointment_fallback_ignored_for_agent_first", "agent_first_callback_ignored_for_voice_ai" ] }, "message": { "type": "string" }, "campaignId": { "type": "string" }, "campaignName": { "type": "string" }, "campaignKind": { "type": "string", "enum": [ "voice_ai", "agent_first" ] } }, "required": [ "code", "message" ], "additionalProperties": false } }, "assignedCampaignCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "clientId", "name", "description", "configuration", "routingConfigId", "appointmentConfigId", "callFormId", "createdAt", "updatedAt", "routingConfig", "readiness", "compatibilityWarnings" ], "additionalProperties": false } }, "required": [ "transferConfig" ], "additionalProperties": false }, "GetV2RoutingGroupsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2RoutingGroupsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdParameterId": { "description": "Transfer config ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2RoutingGroupsIdPositiveResponse": { "type": "object", "properties": { "transferConfig": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } }, "additionalProperties": false }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ], "additionalProperties": false } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Transfer config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Transfer config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "clientId", "name", "description", "configuration", "routingConfigId", "appointmentConfigId", "callFormId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "transferConfig" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2RoutingGroupsIdRequestBody": { "anyOf": [ { "type": "object", "properties": { "expectedUsageHash": { "type": "string", "minLength": 64, "maxLength": 64 }, "expectedUpdatedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "name": { "description": "Transfer config name", "type": "string", "minLength": 1 }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ] } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ] } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ] } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ] }, "agentFirstHandling": { "type": [ "object", "null" ], "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } } }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } } } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ] } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ] } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ] } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ] } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ] }, "agentFirstHandling": { "type": [ "object", "null" ], "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } } }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } } } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ] } } }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ] } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false } }, "required": [ "configuration" ], "additionalProperties": false }, { "type": "object", "properties": { "description": { "type": [ "string", "null" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "type": { "type": "string", "enum": [ "direct", "dynamic", "sip", "softphone" ] }, "warmTransfer": { "type": "boolean" }, "directPhoneNumber": { "type": [ "string", "null" ], "maxLength": 20 }, "dynamicOptions": { "type": [ "object", "null" ], "properties": { "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "number" }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ] } } } }, "sipUri": { "type": [ "string", "null" ] }, "sipHeaders": { "type": [ "string", "null" ] }, "softphoneFallbackType": { "type": [ "string", "null" ], "enum": [ "appointment_booking", "phone_number", "none", null ] }, "softphoneFallbackPhoneNumber": { "type": [ "string", "null" ], "maxLength": 20 }, "agentFirstFallbackConfig": { "type": [ "object", "null" ], "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } } }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } } }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "softphoneHandoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedUsageHash": { "type": "string", "minLength": 64, "maxLength": 64 }, "expectedUpdatedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "name": { "description": "Transfer config name", "type": "string", "minLength": 1 } }, "required": [], "additionalProperties": false } ] }, "DeleteV2RoutingGroupsIdParameterExpectedUpdatedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "DeleteV2RoutingGroupsIdParameterId": { "description": "Transfer config ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2RoutingGroupsIdPositiveResponse": { "type": "object", "properties": { "transferConfig": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } }, "additionalProperties": false }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ], "additionalProperties": false } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Transfer config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Transfer config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "clientId", "name", "description", "configuration", "routingConfigId", "appointmentConfigId", "callFormId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "transferConfig" ], "additionalProperties": false }, "DeleteV2RoutingGroupsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2RoutingGroupsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2RoutingGroupsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2RoutingGroupsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2RoutingGroupsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2RoutingGroupsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2RoutingGroupsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2RoutingGroupsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2RoutingGroupsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2RoutingGroupsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsPositiveResponse": { "type": "object", "properties": { "transferConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } }, "additionalProperties": false }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ], "additionalProperties": false } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Transfer config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Transfer config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "routingConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Routing config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Routing config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "routingType": { "type": "string", "enum": [ "linear", "balanced", "weighted", "grouped" ] }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fallbackBehavior": { "type": "string", "enum": [ "voicemail", "schedule_meeting", "transfer_to_number" ] }, "fallbackNumber": { "type": [ "string", "null" ], "maxLength": 20 }, "maxRingPerAgent": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxWaitTime": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "tryCustomerAgentFirst": { "type": [ "boolean", "null" ] }, "tryPreviousSoftphoneAgentFirst": { "type": [ "boolean", "null" ] }, "customerAgentPriority": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "previousSoftphoneAgentPriority": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "stateBasedRouting": { "type": [ "boolean", "null" ] }, "stateRoutingFallback": { "type": "string", "enum": [ "fallback", "all_agents" ] }, "agents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Routing agent creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Routing agent last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "routingConfigId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "memberId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "groupId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weight": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "lastCallAt": { "description": "Routing agent last call time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "isActive": { "type": [ "boolean", "null" ] }, "skills": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "member": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Member creation time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "role": { "type": "string" }, "removedAt": { "description": "Member removal time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "removedByUserId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "removedReason": { "type": [ "string", "null" ] }, "replacementMemberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "filterData": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "id", "name", "email" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "clientId", "userId", "role", "removedAt", "removedByUserId", "removedReason", "replacementMemberId", "filterData", "user" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "routingConfigId", "memberId", "groupId", "priority", "weight", "lastCallAt", "isActive", "skills" ], "additionalProperties": false } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Routing group creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Routing group last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "routingConfigId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "routingType": { "type": "string", "enum": [ "linear", "balanced", "weighted" ] }, "priority": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "isActive": { "type": [ "boolean", "null" ] }, "agents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Routing agent creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Routing agent last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "routingConfigId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "memberId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "groupId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priority": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weight": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "lastCallAt": { "description": "Routing agent last call time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "isActive": { "type": [ "boolean", "null" ] }, "skills": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "member": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Member creation time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "role": { "type": "string" }, "removedAt": { "description": "Member removal time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "removedByUserId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "removedReason": { "type": [ "string", "null" ] }, "replacementMemberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "filterData": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "id", "name", "email" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "clientId", "userId", "role", "removedAt", "removedByUserId", "removedReason", "replacementMemberId", "filterData", "user" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "routingConfigId", "memberId", "groupId", "priority", "weight", "lastCallAt", "isActive", "skills" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "routingConfigId", "name", "description", "routingType", "priority", "isActive", "agents" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "name", "description", "routingType", "clientId", "fallbackBehavior", "fallbackNumber", "maxRingPerAgent", "maxWaitTime", "tryCustomerAgentFirst", "tryPreviousSoftphoneAgentFirst", "customerAgentPriority", "previousSoftphoneAgentPriority", "stateBasedRouting", "stateRoutingFallback", "agents", "groups" ], "additionalProperties": false }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "compatibilityWarnings": { "default": [], "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "appointment_fallback_ignored_for_agent_first", "agent_first_callback_ignored_for_voice_ai" ] }, "message": { "type": "string" }, "campaignId": { "type": "string" }, "campaignName": { "type": "string" }, "campaignKind": { "type": "string", "enum": [ "voice_ai", "agent_first" ] } }, "required": [ "code", "message" ], "additionalProperties": false } }, "assignedCampaignCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "clientId", "name", "description", "configuration", "routingConfigId", "appointmentConfigId", "callFormId", "createdAt", "updatedAt", "routingConfig", "readiness", "compatibilityWarnings" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "transferConfigs", "total" ], "additionalProperties": false }, "GetV2RoutingGroupsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2RoutingGroupsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2RoutingGroupsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2RoutingGroupsPositiveResponse": { "type": "object", "properties": { "transferConfig": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } }, "additionalProperties": false }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ], "additionalProperties": false } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Transfer config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Transfer config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "clientId", "name", "description", "configuration", "routingConfigId", "appointmentConfigId", "callFormId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "transferConfig" ], "additionalProperties": false }, "PostV2RoutingGroupsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2RoutingGroupsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2RoutingGroupsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2RoutingGroupsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2RoutingGroupsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2RoutingGroupsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2RoutingGroupsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2RoutingGroupsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2RoutingGroupsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2RoutingGroupsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2RoutingGroupsRequestBody": { "anyOf": [ { "type": "object", "properties": { "name": { "description": "Transfer config name", "type": "string", "minLength": 1 }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ] } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ] } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ] } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ] }, "agentFirstHandling": { "type": [ "object", "null" ], "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } } }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } } } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ] } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ] } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ] } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ] } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ] } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ] }, "agentFirstHandling": { "type": [ "object", "null" ], "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } } }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } } } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ] } } }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ] } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false } }, "required": [ "name", "configuration" ], "additionalProperties": false }, { "type": "object", "properties": { "description": { "type": [ "string", "null" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "type": { "type": "string", "enum": [ "direct", "dynamic", "sip", "softphone" ] }, "warmTransfer": { "type": "boolean" }, "directPhoneNumber": { "type": [ "string", "null" ], "maxLength": 20 }, "dynamicOptions": { "type": [ "object", "null" ], "properties": { "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "number" }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ] } } } }, "sipUri": { "type": [ "string", "null" ] }, "sipHeaders": { "type": [ "string", "null" ] }, "softphoneFallbackType": { "type": [ "string", "null" ], "enum": [ "appointment_booking", "phone_number", "none", null ] }, "softphoneFallbackPhoneNumber": { "type": [ "string", "null" ], "maxLength": 20 }, "agentFirstFallbackConfig": { "type": [ "object", "null" ], "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } } }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } } }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "softphoneHandoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "description": "Transfer config name", "type": "string", "minLength": 1 } }, "required": [ "name" ], "additionalProperties": false } ] }, "GetV2CalendarsIdParameterId": { "description": "Calendar ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CalendarsIdPositiveResponse": { "type": "object", "properties": { "appointmentConfig": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Calendar creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Calendar last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentLength": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentSpacing": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxOptions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "minHours": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ], "additionalProperties": false }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ], "additionalProperties": false } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ], "additionalProperties": false } }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "activeBookingLinkCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "upcomingAppointmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedByScenarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "assignedCampaignCount": { "type": "number" }, "assignedTransferConfigCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByTransferConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "concurrentLimit", "appointmentLength", "appointmentSpacing", "maxOptions", "minDate", "maxDate", "minHours", "preferredMode", "appointmentMode", "showCallerIdOnBookingPage", "assignmentMode", "routingConfigId", "transferConfigId", "workflows", "bookingHours", "createdBy", "updatedBy" ], "additionalProperties": false } }, "required": [ "appointmentConfig" ], "additionalProperties": false }, "GetV2CalendarsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CalendarsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CalendarsIdParameterId": { "description": "Calendar ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CalendarsIdPositiveResponse": { "type": "object", "properties": { "appointmentConfig": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Calendar creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Calendar last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentLength": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentSpacing": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxOptions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "minHours": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ], "additionalProperties": false }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ], "additionalProperties": false } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ], "additionalProperties": false } }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "activeBookingLinkCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "upcomingAppointmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedByScenarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "assignedCampaignCount": { "type": "number" }, "assignedTransferConfigCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByTransferConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "concurrentLimit", "appointmentLength", "appointmentSpacing", "maxOptions", "minDate", "maxDate", "minHours", "preferredMode", "appointmentMode", "showCallerIdOnBookingPage", "assignmentMode", "routingConfigId", "transferConfigId", "workflows", "bookingHours", "createdBy", "updatedBy" ], "additionalProperties": false } }, "required": [ "appointmentConfig" ], "additionalProperties": false }, "PatchV2CalendarsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CalendarsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CalendarsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CalendarsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CalendarsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CalendarsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CalendarsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CalendarsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CalendarsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CalendarsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CalendarsIdRequestBody": { "type": "object", "properties": { "name": { "description": "Calendar name", "type": "string", "minLength": 1 }, "description": { "description": "Markdown-supported description shown on the public booking page", "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": 1, "maximum": 20 }, "appointmentLength": { "type": "integer", "minimum": 5, "maximum": 240, "multipleOf": 5 }, "appointmentSpacing": { "type": "integer", "minimum": 5, "maximum": 240, "multipleOf": 5 }, "maxOptions": { "type": "integer", "minimum": 1, "maximum": 5 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date", "maxLength": 10 }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date", "maxLength": 10 }, "minHours": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "description": "Legacy routing mirror for routing_config assignments. Prefer transferConfigId.", "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "description": "Routing group for routing_config and external_transfer assignments", "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ] }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ] } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ] } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ] } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ] } }, "expectedUsageHash": { "type": "string", "minLength": 64, "maxLength": 64 }, "expectedUpdatedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [] }, "DeleteV2CalendarsIdParameterExpectedUpdatedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "DeleteV2CalendarsIdParameterId": { "description": "Calendar ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CalendarsIdPositiveResponse": { "type": "object", "properties": { "appointmentConfig": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Calendar creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Calendar last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentLength": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentSpacing": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxOptions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "minHours": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ], "additionalProperties": false }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ], "additionalProperties": false } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ], "additionalProperties": false } }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "activeBookingLinkCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "upcomingAppointmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedByScenarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "assignedCampaignCount": { "type": "number" }, "assignedTransferConfigCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByTransferConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "concurrentLimit", "appointmentLength", "appointmentSpacing", "maxOptions", "minDate", "maxDate", "minHours", "preferredMode", "appointmentMode", "showCallerIdOnBookingPage", "assignmentMode", "routingConfigId", "transferConfigId", "workflows", "bookingHours", "createdBy", "updatedBy" ], "additionalProperties": false } }, "required": [ "appointmentConfig" ], "additionalProperties": false }, "DeleteV2CalendarsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CalendarsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CalendarsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CalendarsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CalendarsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CalendarsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CalendarsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CalendarsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CalendarsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CalendarsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsPositiveResponse": { "type": "object", "properties": { "appointmentConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Calendar creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Calendar last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentLength": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentSpacing": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxOptions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "minHours": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ], "additionalProperties": false }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ], "additionalProperties": false } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ], "additionalProperties": false } }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "activeBookingLinkCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "upcomingAppointmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedByScenarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "assignedCampaignCount": { "type": "number" }, "assignedTransferConfigCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByTransferConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "concurrentLimit", "appointmentLength", "appointmentSpacing", "maxOptions", "minDate", "maxDate", "minHours", "preferredMode", "appointmentMode", "showCallerIdOnBookingPage", "assignmentMode", "routingConfigId", "transferConfigId", "workflows", "bookingHours", "createdBy", "updatedBy" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "appointmentConfigs", "total" ], "additionalProperties": false }, "GetV2CalendarsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CalendarsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CalendarsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CalendarsPositiveResponse": { "type": "object", "properties": { "appointmentConfig": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Calendar creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Calendar last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentLength": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentSpacing": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxOptions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "minHours": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ], "additionalProperties": false }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ], "additionalProperties": false } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ], "additionalProperties": false } }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "activeBookingLinkCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "upcomingAppointmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedByScenarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "assignedCampaignCount": { "type": "number" }, "assignedTransferConfigCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByTransferConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "concurrentLimit", "appointmentLength", "appointmentSpacing", "maxOptions", "minDate", "maxDate", "minHours", "preferredMode", "appointmentMode", "showCallerIdOnBookingPage", "assignmentMode", "routingConfigId", "transferConfigId", "workflows", "bookingHours", "createdBy", "updatedBy" ], "additionalProperties": false } }, "required": [ "appointmentConfig" ], "additionalProperties": false }, "PostV2CalendarsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CalendarsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CalendarsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CalendarsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CalendarsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CalendarsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CalendarsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CalendarsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CalendarsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CalendarsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CalendarsRequestBody": { "type": "object", "properties": { "name": { "description": "Calendar name", "type": "string", "minLength": 1 }, "description": { "description": "Markdown-supported description shown on the public booking page", "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": 1, "maximum": 20 }, "appointmentLength": { "type": "integer", "minimum": 5, "maximum": 240, "multipleOf": 5 }, "appointmentSpacing": { "type": "integer", "minimum": 5, "maximum": 240, "multipleOf": 5 }, "maxOptions": { "type": "integer", "minimum": 1, "maximum": 5 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date", "maxLength": 10 }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date", "maxLength": 10 }, "minHours": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "description": "Legacy routing mirror for routing_config assignments. Prefer transferConfigId.", "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "description": "Routing group for routing_config and external_transfer assignments", "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ] }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ] } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ] } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ] } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ] } } } }, "GetV2PhoneSuppressionsSuppressIdParameterId": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[a-zA-Z0-9-]+$" }, "GetV2PhoneSuppressionsSuppressIdPositiveResponse": { "type": "object", "properties": { "jobId": { "type": "string" }, "state": { "type": "string", "enum": [ "queued", "active", "completed", "failed" ] }, "createdAt": { "type": "string" }, "finishedAt": { "default": null, "type": [ "number", "null" ] }, "progress": { "type": "object", "properties": { "processed": { "type": "number" }, "total": { "type": [ "number", "null" ] }, "phase": { "type": "string", "enum": [ "queued", "downloading", "parsing", "importing" ] } }, "required": [ "processed", "total" ], "additionalProperties": false }, "result": { "type": [ "object", "null" ], "properties": { "kind": { "type": "string", "const": "api" }, "summary": { "type": "object", "properties": { "total": { "type": "number" }, "valid": { "type": "number" }, "duplicates": { "type": "number" }, "invalid": { "type": "number" }, "defaultedReasons": { "default": 0, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "created": { "type": "number" }, "existing": { "type": "number" }, "replayed": { "type": "number" }, "failed": { "type": "number" }, "errors": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "row": { "type": "number" }, "message": { "type": "string" } }, "required": [ "row", "message" ], "additionalProperties": false } } }, "required": [ "total", "valid", "duplicates", "invalid", "defaultedReasons", "created", "existing", "replayed", "failed", "errors" ], "additionalProperties": false } }, "required": [ "kind", "summary" ], "additionalProperties": false }, "error": { "type": [ "string", "null" ] } }, "required": [ "jobId", "state", "createdAt", "finishedAt", "progress", "result", "error" ], "additionalProperties": false }, "GetV2PhoneSuppressionsSuppressIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2PhoneSuppressionsSuppressIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2PhoneSuppressionsSuppressIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2PhoneSuppressionsSuppressIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2PhoneSuppressionsSuppressIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2PhoneSuppressionsSuppressIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2PhoneSuppressionsSuppressIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2PhoneSuppressionsSuppressIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2PhoneSuppressionsSuppressIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2PhoneSuppressionsSuppressIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressPositiveResponse": { "type": "object", "properties": { "jobId": { "type": "string" }, "status": { "type": "string", "const": "accepted" }, "acceptedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "jobId", "status", "acceptedCount" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PhoneSuppressionsSuppressRequestBody": { "type": "object", "properties": { "records": { "description": "One or more phone numbers to suppress, up to 1,000 records.", "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "description": "Phone number to suppress. Formatting is normalized automatically.", "type": "string", "minLength": 7, "maxLength": 40 }, "reason": { "description": "Optional reason code. Blank or unrecognized reasons use other.", "default": "other", "type": "string", "enum": [ "abusive_behavior", "customer_request", "deceased", "duplicate_recently_handled", "failed_verification", "not_interested", "other", "out_of_network", "repeated_shopping", "suspected_fraud_spam", "wrong_person_invalid_number" ] } }, "required": [ "phoneNumber" ], "additionalProperties": false } } }, "required": [ "records" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsParameterId": { "description": "Appointment ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2AppointmentsIdEventsPositiveResponse": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "type": { "type": "string", "enum": [ "created", "confirmed", "rescheduled", "cancelled", "member_reassigned", "no_show", "completed", "reminder_sent", "confirmation_sent", "call_failed" ] }, "actor": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "customer", "ai_assistant", "system" ] }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "userName": { "type": [ "string", "null" ] }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "toolCallId": { "type": [ "string", "null" ] }, "reason": { "type": "string" } }, "required": [ "kind" ], "additionalProperties": false }, "metadata": { "type": [ "object", "null" ], "properties": { "fromStartTime": { "description": "ISO 8601 timestamp", "type": "string", "format": "date-time" }, "toStartTime": { "description": "ISO 8601 timestamp", "type": "string", "format": "date-time" }, "fromEndTime": { "description": "ISO 8601 timestamp", "type": "string", "format": "date-time" }, "toEndTime": { "description": "ISO 8601 timestamp", "type": "string", "format": "date-time" }, "fromNoShow": { "type": "boolean" }, "reason": { "type": [ "string", "null" ] }, "fromMemberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "toMemberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "channel": { "type": "string", "enum": [ "sms", "email" ] }, "template": { "type": "string" }, "sms": { "type": "object", "properties": { "smsHistoryId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "content": { "type": "string" }, "sentAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "messagingChannel": { "type": "string", "enum": [ "tells", "telnyx_sms", "telnyx_rcs" ] } }, "required": [ "smsHistoryId", "content", "sentAt", "messagingChannel" ], "additionalProperties": false }, "missingVars": { "type": "array", "items": { "type": "string" } }, "noShowTextSkipped": { "type": "boolean", "const": true } }, "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "type", "actor", "metadata", "createdAt" ], "additionalProperties": false } } }, "required": [ "events" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdEventsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdParameterId": { "description": "Appointment ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2AppointmentsIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startTime": { "description": "Appointment start time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "endTime": { "description": "Appointment end time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "timezone": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] }, "title": { "type": [ "string", "null" ] }, "appointmentMode": { "type": [ "string", "null" ], "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call", null ] }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "bookingSource": { "type": [ "string", "null" ], "enum": [ "ai_assistant", "manual", "scheduling_page", null ] }, "originCallId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "confirmedAt": { "description": "Appointment confirmation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "additionalNotes": { "type": [ "string", "null" ] }, "calendarEventId": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "meetingUrl": { "type": [ "string", "null" ] }, "cancelledAt": { "description": "Appointment cancellation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "cancellationReason": { "type": [ "string", "null" ] }, "createdAt": { "description": "Appointment creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Appointment last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customer": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": "string", "maxLength": 255 } }, "required": [ "id", "firstName", "lastName", "callerId" ], "additionalProperties": false }, "member": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "image" ], "additionalProperties": false }, "appointmentConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "campaign": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "callbackAttempt": { "type": [ "object", "null" ], "properties": { "callId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "attemptedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "enum": [ "attempted", "attempted_failed", "attempted_no_answer", "completed" ] }, "label": { "type": "string" } }, "required": [ "callId", "attemptedAt", "status", "label" ], "additionalProperties": false } }, "required": [ "id", "startTime", "endTime", "timezone", "status", "title", "appointmentMode", "appointmentConfigId", "bookingSource", "originCallId", "confirmedAt", "additionalNotes", "calendarEventId", "location", "meetingUrl", "cancelledAt", "cancellationReason", "createdAt", "updatedAt", "customer", "member", "appointmentConfig", "campaign" ], "additionalProperties": false }, "GetV2AppointmentsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2AppointmentsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsParameterStartDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "GetV2AppointmentsParameterEndDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "GetV2AppointmentsParameterMember": { "description": "Comma-separated member UUIDs. Filter to appointments assigned to any of these members.", "type": "string" }, "GetV2AppointmentsParameterClientCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2AppointmentsParameterAppointmentConfigId": { "description": "Comma-separated appointment config UUIDs. Filter to appointments using any of these scheduling configs.", "type": "string" }, "GetV2AppointmentsParameterCampaignId": { "description": "Comma-separated campaign UUIDs. Filter to appointments originating from any of these campaigns.", "type": "string" }, "GetV2AppointmentsParameterStatus": { "description": "Comma-separated status filter. Omit to return all statuses.", "type": "string" }, "GetV2AppointmentsParameterBookingSource": { "description": "Comma-separated booking source filter", "type": "string" }, "GetV2AppointmentsParameterAppointmentMode": { "description": "Comma-separated appointment mode filter", "type": "string" }, "GetV2AppointmentsParameterSort": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] }, "GetV2AppointmentsParameterLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 500 }, "GetV2AppointmentsParameterCursor": { "type": "string" }, "GetV2AppointmentsPositiveResponse": { "type": "object", "properties": { "appointments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startTime": { "description": "Appointment start time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "endTime": { "description": "Appointment end time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "timezone": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] }, "title": { "type": [ "string", "null" ] }, "appointmentMode": { "type": [ "string", "null" ], "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call", null ] }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "bookingSource": { "type": [ "string", "null" ], "enum": [ "ai_assistant", "manual", "scheduling_page", null ] }, "originCallId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "confirmedAt": { "description": "Appointment confirmation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "additionalNotes": { "type": [ "string", "null" ] }, "calendarEventId": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "meetingUrl": { "type": [ "string", "null" ] }, "cancelledAt": { "description": "Appointment cancellation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "cancellationReason": { "type": [ "string", "null" ] }, "createdAt": { "description": "Appointment creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Appointment last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customer": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": "string", "maxLength": 255 } }, "required": [ "id", "firstName", "lastName", "callerId" ], "additionalProperties": false }, "member": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "image" ], "additionalProperties": false }, "appointmentConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "campaign": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "callbackAttempt": { "type": [ "object", "null" ], "properties": { "callId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "attemptedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "enum": [ "attempted", "attempted_failed", "attempted_no_answer", "completed" ] }, "label": { "type": "string" } }, "required": [ "callId", "attemptedAt", "status", "label" ], "additionalProperties": false } }, "required": [ "id", "startTime", "endTime", "timezone", "status", "title", "appointmentMode", "appointmentConfigId", "bookingSource", "originCallId", "confirmedAt", "additionalNotes", "calendarEventId", "location", "meetingUrl", "cancelledAt", "cancellationReason", "createdAt", "updatedAt", "customer", "member", "appointmentConfig", "campaign" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextCursor": { "type": [ "string", "null" ] } }, "required": [ "appointments", "total", "nextCursor" ], "additionalProperties": false }, "GetV2AppointmentsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2AppointmentsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2AppointmentsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeParameterCode": { "type": "string", "minLength": 1 }, "DeleteV2BookingLinksCodePositiveResponse": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2BookingLinksCodeNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2BookingLinksParameterClientCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2BookingLinksParameterAppointmentConfigId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2BookingLinksParameterIncludeRevoked": { "type": "string" }, "GetV2BookingLinksPositiveResponse": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "clientCustomerId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expiresAt": {}, "revokedAt": {}, "createdAt": {}, "url": { "type": "string" } }, "required": [ "code", "clientCustomerId", "appointmentConfigId", "expiresAt", "revokedAt", "createdAt", "url" ], "additionalProperties": false } } }, "required": [ "links" ], "additionalProperties": false }, "GetV2BookingLinksNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2BookingLinksNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2BookingLinksNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2BookingLinksNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2BookingLinksNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2BookingLinksNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2BookingLinksNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2BookingLinksNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2BookingLinksNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2BookingLinksNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2BookingLinksPositiveResponse": { "type": "object", "properties": { "code": { "type": "string" }, "clientCustomerId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expiresAt": {}, "revokedAt": {}, "createdAt": {}, "url": { "type": "string" } }, "required": [ "code", "clientCustomerId", "appointmentConfigId", "expiresAt", "revokedAt", "createdAt", "url" ], "additionalProperties": false }, "PostV2BookingLinksNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2BookingLinksNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2BookingLinksNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2BookingLinksNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2BookingLinksNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2BookingLinksNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2BookingLinksNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2BookingLinksNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2BookingLinksNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2BookingLinksNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2BookingLinksRequestBody": { "type": "object", "properties": { "clientCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "clientCustomerId", "appointmentConfigId" ] }, "GetV2CampaignsOptionsPositiveResponse": { "type": "object", "properties": { "items": { "description": "Campaigns available to filter/enroll customers into", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "maxLength": 255 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "completed", "archived", "cancelled" ] }, "isReceptionist": { "type": "boolean" } }, "required": [ "id", "name", "status", "isReceptionist" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "GetV2CampaignsOptionsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsOptionsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsOptionsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsOptionsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsOptionsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsOptionsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsOptionsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsOptionsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsOptionsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsOptionsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesParameterTag": { "type": "string", "minLength": 1 }, "GetV2CampaignsCampaignTemplatesParameterVertical": { "type": "string", "enum": [ "aca", "medicare", "hospital_indemnity", "home_health_care", "final_expense" ] }, "GetV2CampaignsCampaignTemplatesPositiveResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "tags": { "type": "array", "items": { "type": "string" } }, "vertical": { "type": "string", "enum": [ "aca", "medicare", "hospital_indemnity", "home_health_care", "final_expense" ] }, "isReceptionist": { "type": "boolean" }, "direction": { "type": "string" }, "callerIdSource": { "type": "string", "enum": [ "client_main", "campaign_pool" ] }, "publishedVersionId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientFacingDescription": { "type": [ "string", "null" ] }, "happyPathConversation": { "type": [ "string", "null" ] }, "defaultAutomationConfigs": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "dispositionGroup": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "pulseWorkflow": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "canvas": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] } }, "required": [ "id", "canvas" ], "additionalProperties": false }, "automationTemplates": { "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "isActive": { "type": "boolean" }, "triggerType": { "type": "string", "enum": [ "lead_created", "customer_created", "policy_created", "policy_status_changed", "campaign_completed", "campaign_failed", "temporal", "date_of_birth", "day_of_year", "policy_changed", "customer_field_changed", "time_in_campaign", "task_completed" ] }, "triggerConfig": { "anyOf": [ { "type": "object", "properties": { "dateField": { "type": "string", "enum": [ "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "paidThroughDate", "gracePeriodStartDate" ] }, "offsetDays": { "type": "integer", "minimum": 0, "maximum": 365 }, "direction": { "type": "string", "enum": [ "before", "after" ] } }, "required": [ "dateField", "offsetDays", "direction" ], "additionalProperties": false }, { "type": "object", "properties": { "offsetDays": { "type": "integer", "minimum": 0, "maximum": 365 }, "direction": { "type": "string", "enum": [ "before", "after" ] }, "atAge": { "type": "integer", "minimum": 0, "maximum": 120 } }, "required": [ "offsetDays", "direction" ], "additionalProperties": false }, { "type": "object", "properties": { "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "day": { "type": "integer", "minimum": 1, "maximum": 31 } }, "required": [ "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "days": { "type": "integer", "minimum": 1, "maximum": 3650 }, "sourceCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "days" ], "additionalProperties": false }, { "type": "object", "properties": { "sourceCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "sourceCampaignId" ], "additionalProperties": false }, { "type": "object", "properties": { "tagName": { "type": "string", "minLength": 1 }, "taskStatus": { "type": "string", "enum": [ "done", "cancelled" ] }, "policyStatusFilter": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved" ] } } }, "required": [ "tagName", "taskStatus" ], "additionalProperties": false }, { "type": "object", "properties": { "fromStatus": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] }, "toStatus": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] }, "fromStatuses": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] } }, "toStatuses": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] } } }, "additionalProperties": false }, { "type": "object", "properties": { "filters": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "const": "state" }, "operator": { "type": "string", "const": "equals" }, "value": { "anyOf": [ { "type": "string", "minLength": 1 }, { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } ] } }, "required": [ "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string", "const": "source" }, "operator": { "type": "string", "const": "equals" }, "value": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ] } }, "required": [ "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string", "const": "custom_field" }, "operator": { "type": "string", "const": "equals" }, "fieldKey": { "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "fieldKey", "value" ], "additionalProperties": false } ] } } }, "additionalProperties": false } ] } }, "required": [ "id", "name", "description", "isActive", "triggerType" ], "additionalProperties": false } }, "requiredVars": { "default": [], "type": "array", "items": { "type": "string" } }, "behaviorPresets": { "type": "array", "items": { "type": "object", "properties": { "behaviorKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scenarioName": { "type": [ "string", "null" ] }, "action": { "type": [ "string", "null" ] }, "scope": { "type": "string", "enum": [ "business_hours", "after_hours" ] }, "enabled": { "type": "boolean" }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isDefault": { "type": "boolean" }, "appliesTo": { "type": [ "array", "null" ], "items": { "type": "string" } }, "destinationRequirement": { "type": [ "string", "null" ], "enum": [ "routing_group", "calendar", null ] } }, "required": [ "behaviorKey", "scenarioName", "action", "scope", "enabled", "priority", "isDefault", "appliesTo", "destinationRequirement" ], "additionalProperties": false } }, "warnings": { "default": [], "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "tags", "vertical", "isReceptionist", "direction", "callerIdSource", "publishedVersionId", "clientFacingDescription", "happyPathConversation", "defaultAutomationConfigs", "dispositionGroup", "pulseWorkflow", "automationTemplates", "requiredVars", "behaviorPresets", "warnings" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignTemplatesNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdParameterId": { "description": "Restriction ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdPositiveResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "success" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdAgentSourceRestrictionsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsPositiveResponse": { "type": "object", "properties": { "restrictions": { "description": "Array of agent source restrictions", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Restriction creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Restriction last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "memberId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignSourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "description": "Source ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignName": { "type": "string" }, "memberName": { "type": "string" }, "sourceName": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "campaignId", "memberId", "campaignSourceId", "sourceId" ], "additionalProperties": false } } }, "required": [ "restrictions" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsPositiveResponse": { "type": "object", "properties": { "restriction": { "description": "Created restriction record", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Restriction creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Restriction last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "memberId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignSourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "description": "Source ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignName": { "type": "string" }, "memberName": { "type": "string" }, "sourceName": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "campaignId", "memberId", "campaignSourceId", "sourceId" ], "additionalProperties": false } }, "required": [ "restriction" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdAgentSourceRestrictionsRequestBody": { "type": "object", "properties": { "memberId": { "description": "Member/Agent ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "description": "Source ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "memberId", "sourceId" ] }, "PostV2CampaignsCampaignIdDispositionsBulkParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CampaignsCampaignIdDispositionsBulkPositiveResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "added": { "type": "number" }, "message": { "type": "string" } }, "required": [ "success", "added", "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsBulkRequestBody": { "type": "object", "properties": { "dispositionIds": { "description": "Array of disposition IDs to add", "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "dispositionIds" ] }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdParameterDispositionId": { "description": "Disposition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdPositiveResponse": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "dispositionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "enabled": { "type": "boolean" }, "snippetOverride": { "type": [ "string", "null" ] }, "createdAt": { "description": "Campaign disposition creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Campaign disposition last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "disposition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Disposition creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Disposition last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "name": { "type": "string" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "description": { "type": [ "string", "null" ] }, "defaultSnippet": { "type": [ "string", "null" ] }, "category": { "type": "string", "enum": [ "system", "feature", "library" ] }, "requiredCapability": { "type": [ "string", "null" ] }, "isImmutable": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "shouldSeed": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "availableForSoftphone": { "type": "boolean" }, "outcomeType": { "type": [ "string", "null" ], "enum": [ "contacted", "bad_contact", "no_contact", "voicemail", "sale", "no_sale", "callback", "dnc", "rewrite", "resolved", "unresolved", "disqualified", "abandoned", null ] } }, "required": [ "id", "createdAt", "updatedAt", "name", "clientId", "description", "defaultSnippet", "category", "requiredCapability", "isImmutable", "isHidden", "shouldSeed", "isArchived", "availableForSoftphone", "outcomeType" ], "additionalProperties": false }, "resolvedSnippet": { "type": [ "string", "null" ] }, "isImplicit": { "description": "True for system/feature dispositions that are not stored in campaign_dispositions", "type": "boolean" }, "isEditable": { "description": "True for library dispositions that can be enabled/disabled", "type": "boolean" } }, "required": [ "id", "campaignId", "dispositionId", "enabled", "snippetOverride", "createdAt", "updatedAt", "isImplicit", "isEditable" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdDispositionsDispositionIdRequestBody": { "type": "object", "properties": { "enabled": { "description": "Whether to enable", "type": "boolean" }, "snippetOverride": { "type": [ "string", "null" ] } }, "required": [] }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdParameterDispositionId": { "description": "Disposition ID to remove", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdPositiveResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CampaignsCampaignIdDispositionsDispositionIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdDispositionsPositiveResponse": { "type": "object", "properties": { "dispositions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "dispositionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "enabled": { "type": "boolean" }, "snippetOverride": { "type": [ "string", "null" ] }, "createdAt": { "description": "Campaign disposition creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Campaign disposition last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "disposition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Disposition creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Disposition last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "name": { "type": "string" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "description": { "type": [ "string", "null" ] }, "defaultSnippet": { "type": [ "string", "null" ] }, "category": { "type": "string", "enum": [ "system", "feature", "library" ] }, "requiredCapability": { "type": [ "string", "null" ] }, "isImmutable": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "shouldSeed": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "availableForSoftphone": { "type": "boolean" }, "outcomeType": { "type": [ "string", "null" ], "enum": [ "contacted", "bad_contact", "no_contact", "voicemail", "sale", "no_sale", "callback", "dnc", "rewrite", "resolved", "unresolved", "disqualified", "abandoned", null ] } }, "required": [ "id", "createdAt", "updatedAt", "name", "clientId", "description", "defaultSnippet", "category", "requiredCapability", "isImmutable", "isHidden", "shouldSeed", "isArchived", "availableForSoftphone", "outcomeType" ], "additionalProperties": false }, "resolvedSnippet": { "type": [ "string", "null" ] }, "isImplicit": { "description": "True for system/feature dispositions that are not stored in campaign_dispositions", "type": "boolean" }, "isEditable": { "description": "True for library dispositions that can be enabled/disabled", "type": "boolean" } }, "required": [ "id", "campaignId", "dispositionId", "enabled", "snippetOverride", "createdAt", "updatedAt", "isImplicit", "isEditable" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "dispositions", "total" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdDispositionsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CampaignsCampaignIdDispositionsPositiveResponse": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "dispositionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "enabled": { "type": "boolean" }, "snippetOverride": { "type": [ "string", "null" ] }, "createdAt": { "description": "Campaign disposition creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Campaign disposition last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "disposition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Disposition creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Disposition last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "name": { "type": "string" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "description": { "type": [ "string", "null" ] }, "defaultSnippet": { "type": [ "string", "null" ] }, "category": { "type": "string", "enum": [ "system", "feature", "library" ] }, "requiredCapability": { "type": [ "string", "null" ] }, "isImmutable": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "shouldSeed": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "availableForSoftphone": { "type": "boolean" }, "outcomeType": { "type": [ "string", "null" ], "enum": [ "contacted", "bad_contact", "no_contact", "voicemail", "sale", "no_sale", "callback", "dnc", "rewrite", "resolved", "unresolved", "disqualified", "abandoned", null ] } }, "required": [ "id", "createdAt", "updatedAt", "name", "clientId", "description", "defaultSnippet", "category", "requiredCapability", "isImmutable", "isHidden", "shouldSeed", "isArchived", "availableForSoftphone", "outcomeType" ], "additionalProperties": false }, "resolvedSnippet": { "type": [ "string", "null" ] }, "isImplicit": { "description": "True for system/feature dispositions that are not stored in campaign_dispositions", "type": "boolean" }, "isEditable": { "description": "True for library dispositions that can be enabled/disabled", "type": "boolean" } }, "required": [ "id", "campaignId", "dispositionId", "enabled", "snippetOverride", "createdAt", "updatedAt", "isImplicit", "isEditable" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdDispositionsRequestBody": { "type": "object", "properties": { "dispositionId": { "description": "Disposition ID to add", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "enabled": { "description": "Whether to enable", "default": true, "type": "boolean" }, "snippetOverride": { "type": [ "string", "null" ] } }, "required": [ "dispositionId" ] }, "GetV2CampaignsCampaignIdAvailableSnippetsParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdAvailableSnippetsPositiveResponse": { "type": "object", "properties": { "snippets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Prompt snippet creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Prompt snippet last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "examples": { "type": [ "string", "null" ] }, "toolsAllowlist": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "verticalAllowlist": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "isSystem": { "type": "boolean" }, "enabled": { "type": "boolean" }, "assignedBlockId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "examples", "toolsAllowlist", "verticalAllowlist", "isSystem", "enabled", "assignedBlockId" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "snippets", "total" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableSnippetsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdAvailableBlocksPositiveResponse": { "type": "object", "properties": { "blocks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Prompt block creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Prompt block last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "name": { "type": "string", "maxLength": 255 }, "tag": { "type": "string", "maxLength": 100 }, "description": { "type": [ "string", "null" ] }, "toolType": { "type": "string", "maxLength": 50 }, "enabled": { "type": "boolean" }, "kind": { "type": "string", "enum": [ "tool", "context", "memory" ] }, "contract": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "injectionTag": { "type": [ "string", "null" ], "maxLength": 100 } }, "required": [ "id", "createdAt", "updatedAt", "name", "tag", "description", "toolType", "enabled", "kind", "contract", "injectionTag" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "blocks", "total" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdAvailableBlocksNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdBlockSnippetsPositiveResponse": { "type": "object", "properties": { "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Campaign block assignment creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "behaviorKey": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "blockId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "snippetId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "capabilityId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scope": { "type": "string", "enum": [ "business_hours", "after_hours" ] }, "appliesTo": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "enabled": { "type": "boolean" }, "priority": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "isDefault": { "type": "boolean" }, "settings": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "block": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Prompt block creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Prompt block last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "name": { "type": "string", "maxLength": 255 }, "tag": { "type": "string", "maxLength": 100 }, "description": { "type": [ "string", "null" ] }, "toolType": { "type": "string", "maxLength": 50 }, "enabled": { "type": "boolean" }, "kind": { "type": "string", "enum": [ "tool", "context", "memory" ] }, "contract": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "injectionTag": { "type": [ "string", "null" ], "maxLength": 100 } }, "required": [ "id", "createdAt", "updatedAt", "name", "tag", "description", "toolType", "enabled", "kind", "contract", "injectionTag" ], "additionalProperties": false }, "snippet": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Prompt snippet creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Prompt snippet last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "examples": { "type": [ "string", "null" ] }, "toolsAllowlist": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "verticalAllowlist": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "isSystem": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "examples", "toolsAllowlist", "verticalAllowlist", "isSystem", "enabled" ], "additionalProperties": false }, "transferConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Transfer config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Transfer config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } }, "additionalProperties": false }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ], "additionalProperties": false } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "routingConfigId", "configuration", "appointmentConfigId", "callFormId" ], "additionalProperties": false }, "appointmentConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Appointment config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Appointment config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentLength": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentSpacing": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxOptions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "minHours": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "bookingHours": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "concurrentLimit", "appointmentLength", "appointmentSpacing", "maxOptions", "minDate", "maxDate", "minHours", "preferredMode", "appointmentMode", "showCallerIdOnBookingPage", "assignmentMode", "routingConfigId", "transferConfigId", "workflows", "bookingHours", "createdBy", "updatedBy" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "campaignId", "behaviorKey", "blockId", "snippetId", "transferConfigId", "appointmentConfigId", "capabilityId", "scope", "appliesTo", "enabled", "priority", "isDefault", "settings", "block", "snippet" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "assignments", "total" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBlockSnippetsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "Schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/Schema1" } } ] }, "PostV2CampaignsCampaignIdEnrollmentRestartParameterCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CampaignsCampaignIdEnrollmentRestartPositiveResponse": { "type": "object", "properties": { "jobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "statusUrl": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "resolvedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "jobId", "statusUrl", "total", "resolvedCount" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRestartRequestBody": { "type": "object", "properties": { "idempotencyKey": { "description": "Optional retry key. Reuse with the identical payload after a timeout. Without a key, each submission creates a new request.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "customer": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "phoneNumber": { "type": "string", "maxLength": 64 } }, "required": [ "phoneNumber" ], "additionalProperties": false } ] }, { "$ref": "#/components/schemas/Schema1" } ] }, "customers": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "phoneNumber": { "type": "string", "maxLength": 64 } }, "required": [ "phoneNumber" ], "additionalProperties": false } ] }, { "$ref": "#/components/schemas/Schema1" } ] } } }, "required": [], "additionalProperties": false }, "Schema2": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Schema2" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/Schema2" } } ] }, "PostV2CampaignsCampaignIdEnrollmentStatusParameterCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CampaignsCampaignIdEnrollmentStatusPositiveResponse": { "type": "object", "properties": { "jobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "statusUrl": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "resolvedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "jobId", "statusUrl", "total", "resolvedCount" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentStatusRequestBody": { "type": "object", "properties": { "idempotencyKey": { "description": "Optional retry key. Reuse with the identical payload after a timeout. Without a key, each submission creates a new request.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "customer": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "phoneNumber": { "type": "string", "maxLength": 64 } }, "required": [ "phoneNumber" ], "additionalProperties": false } ] }, { "$ref": "#/components/schemas/Schema2" } ] }, "customers": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "phoneNumber": { "type": "string", "maxLength": 64 } }, "required": [ "phoneNumber" ], "additionalProperties": false } ] }, { "$ref": "#/components/schemas/Schema2" } ] } }, "status": { "type": "string", "enum": [ "completed", "failed", "cancelled" ] }, "reason": { "type": "string", "maxLength": 255 } }, "required": [ "status" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdParameterCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdParameterJobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdPositiveResponse": { "type": "object", "properties": { "jobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string", "enum": [ "enroll", "restart", "set_status" ] }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "partial", "failed" ] }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "succeeded": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "completedAt": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "customerId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "duplicateOf": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 9007199254740991 }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "customerId", "phoneNumber", "reference" ] }, "message": { "type": "string" } }, "required": [ "field", "message" ], "additionalProperties": false } }, "outcome": { "type": "string", "enum": [ "pending", "succeeded", "skipped", "failed" ] }, "code": { "anyOf": [ { "type": "string", "enum": [ "enrolled", "restarted", "status_changed", "already_active", "terminal_exists", "blocked_active_retention", "not_enrolled", "customer_not_found", "invalid_customer_reference", "missing_required_fields", "campaign_unavailable", "no_pulse_workflow", "execution_uncertain", "not_processed" ] }, { "type": "null" } ] }, "customerCampaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "index", "customerId", "duplicateOf", "outcome", "code", "customerCampaignId" ], "additionalProperties": false } } }, "required": [ "jobId", "campaignId", "action", "status", "total", "processed", "succeeded", "skipped", "failed", "completedAt", "items" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdEnrollmentRequestsJobIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "Schema3": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/Schema3" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/Schema3" } } ] }, "PostV2CampaignsCampaignIdEnrollmentParameterCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CampaignsCampaignIdEnrollmentPositiveResponse": { "type": "object", "properties": { "jobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "statusUrl": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "resolvedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "jobId", "statusUrl", "total", "resolvedCount" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsCampaignIdEnrollmentRequestBody": { "type": "object", "properties": { "idempotencyKey": { "description": "Optional retry key. Reuse with the identical payload after a timeout. Without a key, each submission creates a new request.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "customer": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "phoneNumber": { "type": "string", "maxLength": 64 } }, "required": [ "phoneNumber" ], "additionalProperties": false } ] }, { "$ref": "#/components/schemas/Schema3" } ] }, "customers": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "customerId" ], "additionalProperties": false }, { "type": "object", "properties": { "phoneNumber": { "type": "string", "maxLength": 64 } }, "required": [ "phoneNumber" ], "additionalProperties": false } ] }, { "$ref": "#/components/schemas/Schema3" } ] } } }, "required": [], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdBehaviorsPositiveResponse": { "type": "object", "properties": { "configurationHash": { "type": "string" }, "configurationReady": { "type": "boolean" }, "configurationIssues": { "type": "array", "items": { "type": "string" } }, "behaviors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "behaviorKey": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "capabilityId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "capabilityToolType": { "type": [ "string", "null" ] }, "capabilityName": { "type": [ "string", "null" ] }, "snippetId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "snippetName": { "type": [ "string", "null" ] }, "scope": { "type": "string", "enum": [ "business_hours", "after_hours" ] }, "enabled": { "type": "boolean" }, "priority": { "type": "number" }, "isDefault": { "type": "boolean" }, "appliesTo": { "type": [ "array", "null" ], "items": { "type": "string" } }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigName": { "type": [ "string", "null" ] }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigName": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] } }, "required": [ "id", "behaviorKey", "capabilityId", "capabilityToolType", "capabilityName", "snippetId", "snippetName", "scope", "enabled", "priority", "isDefault", "appliesTo", "transferConfigId", "transferConfigName", "appointmentConfigId", "appointmentConfigName", "source" ], "additionalProperties": false } }, "transfers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "appointments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "toolType": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "toolType", "name" ], "additionalProperties": false } }, "snippets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "toolsAllowlist": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "toolsAllowlist" ], "additionalProperties": false } } }, "required": [ "configurationHash", "configurationReady", "configurationIssues", "behaviors", "transfers", "appointments", "capabilities", "snippets" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdBehaviorsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsParameterCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PutV2CampaignsCampaignIdBehaviorsPositiveResponse": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CampaignsCampaignIdBehaviorsRequestBody": { "type": "object", "properties": { "expectedHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "behaviors": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "behaviorKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "capabilityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "snippetId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scope": { "type": "string", "enum": [ "business_hours", "after_hours" ] }, "appliesTo": { "type": [ "array", "null" ], "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isDefault": { "type": "boolean" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "behaviorKey", "capabilityId", "snippetId", "scope", "appliesTo", "enabled", "priority", "isDefault", "transferConfigId", "appointmentConfigId" ] } } }, "required": [ "expectedHash", "behaviors" ] }, "GetV2CampaignsCampaignIdPulseOccupancyParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdPulseOccupancyPositiveResponse": { "type": "object", "properties": { "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "generatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "totalMappedCustomers": { "description": "Customers currently mapped onto workflow nodes.", "type": "number" }, "unmappedCustomers": { "description": "Active, non-terminal customers in the campaign without a current mapped Pulse node.", "type": "number" }, "outcomes": { "description": "Campaign-level terminal outcomes that remove customers from the active Pulse flow.", "type": "object", "properties": { "appointmentsBooked": { "description": "Distinct customer campaigns in this campaign with appointment_booked = true.", "type": "number" }, "inquiriesRaised": { "description": "Distinct customer campaigns in this campaign with at least one linked inquiry.", "type": "number" }, "doNotContacts": { "type": "object", "properties": { "total": { "description": "Distinct customer campaigns with any do-not-contact indicator from SMS unsubscribe or call disposition.", "type": "number" }, "fromSms": { "description": "Distinct customer campaigns with an SMS unsubscribe indicator. This is not exclusive with fromCall.", "type": "number" }, "fromCall": { "description": "Distinct customer campaigns with a call disposition of 'Do Not Contact'. This is not exclusive with fromSms.", "type": "number" } }, "required": [ "total", "fromSms", "fromCall" ], "additionalProperties": false } }, "required": [ "appointmentsBooked", "inquiriesRaised", "doNotContacts" ], "additionalProperties": false }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "nodeId": { "description": "Pulse node ID", "type": "string" }, "nodeType": { "type": [ "string", "null" ] }, "totalCustomers": { "description": "Customers currently assigned to this node", "type": "number" }, "pulseStatusCounts": { "description": "Counts grouped by pulse workflow status", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "customerStatusCounts": { "description": "Counts grouped by customer campaign status", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } } }, "required": [ "nodeId", "nodeType", "totalCustomers", "pulseStatusCounts", "customerStatusCounts" ], "additionalProperties": false } } }, "required": [ "campaignId", "generatedAt", "totalMappedCustomers", "unmappedCustomers", "outcomes", "nodes" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdPulseOccupancyNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdStatsPositiveResponse": { "type": "object", "properties": { "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "totalCustomers": { "type": "number" }, "statusDistribution": { "type": "array", "items": { "type": "object", "properties": { "status": { "description": "Customer campaign status", "type": "string" }, "count": { "description": "Count of customers with this status", "type": "number" }, "percentage": { "description": "Percentage of total customers", "type": "string" } }, "required": [ "status", "count", "percentage" ], "additionalProperties": false } }, "pendingBreakdown": { "type": "object", "properties": { "available": { "description": "Pending customers with no contact attempts (attempts=0)", "type": "number" }, "inDistribution": { "description": "Pending customers with at least one contact attempt (attempts>0)", "type": "number" }, "availablePercentage": { "description": "Percentage of total customers that are available", "type": "string" }, "inDistributionPercentage": { "description": "Percentage of total customers in distribution", "type": "string" } }, "required": [ "available", "inDistribution", "availablePercentage", "inDistributionPercentage" ], "additionalProperties": false }, "successBreakdown": { "type": "object", "properties": { "total": { "description": "Total completed customers", "type": "number" }, "transferred": { "description": "Completed via transfer", "type": "number" }, "appointmentBooked": { "description": "Completed via appointment booking", "type": "number" }, "appointmentsAttended": { "description": "Appointments that were attended", "type": "number" } }, "required": [ "total", "transferred", "appointmentBooked", "appointmentsAttended" ], "additionalProperties": false }, "attemptDistribution": { "type": "array", "items": { "type": "object", "properties": { "attempts": { "type": [ "number", "null" ] }, "status": { "description": "Final status after these attempts", "type": "string" }, "count": { "description": "Number of customers", "type": "number" } }, "required": [ "attempts", "status", "count" ], "additionalProperties": false } }, "failureReasons": { "description": "Why customers were skipped/failed, rolled up by client-safe reason", "type": "array", "items": { "type": "object", "properties": { "code": { "description": "Canonical client-facing reason code", "type": "string" }, "category": { "description": "Reason category (compliance, data_quality, unreachable, …)", "type": "string" }, "label": { "description": "Client-safe reason label", "type": "string" }, "description": { "description": "Client-safe reason description", "type": "string" }, "count": { "description": "Customers skipped/failed for this reason", "type": "number" } }, "required": [ "code", "category", "label", "description", "count" ], "additionalProperties": false } }, "exitsByCall": { "description": "Exits bucketed by call attempt, each segmented by terminal disposition", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "description": "Attempt bucket label (e.g. First call)", "type": "string" }, "detail": { "description": "Attempt bucket sublabel (e.g. 2–3 attempts)", "type": "string" }, "total": { "description": "Customers who exited in this attempt bucket", "type": "number" }, "segments": { "description": "Disposition mix within this bucket", "type": "array", "items": { "type": "object", "properties": { "disposition": { "description": "Terminal disposition / outcome-type of the exit", "type": "string" }, "count": { "type": "number" } }, "required": [ "disposition", "count" ], "additionalProperties": false } } }, "required": [ "key", "label", "detail", "total", "segments" ], "additionalProperties": false } }, "successByCall": { "description": "Successful outcomes bucketed by call attempt, segmented by disposition", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "description": "Attempt bucket label (e.g. First call)", "type": "string" }, "detail": { "description": "Attempt bucket sublabel (e.g. 2–3 attempts)", "type": "string" }, "total": { "description": "Customers who exited in this attempt bucket", "type": "number" }, "segments": { "description": "Disposition mix within this bucket", "type": "array", "items": { "type": "object", "properties": { "disposition": { "description": "Terminal disposition / outcome-type of the exit", "type": "string" }, "count": { "type": "number" } }, "required": [ "disposition", "count" ], "additionalProperties": false } } }, "required": [ "key", "label", "detail", "total", "segments" ], "additionalProperties": false } }, "missingRequiredFields": { "description": "Which required fields were missing (and for how many customers)", "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "count": { "type": "number" } }, "required": [ "field", "count" ], "additionalProperties": false } }, "summary": { "type": "object", "properties": { "totalCustomers": { "description": "Total customers in campaign", "type": "number" }, "completed": { "description": "Completed customers", "type": "number" }, "failed": { "description": "Failed customers", "type": "number" }, "pending": { "description": "Pending customers", "type": "number" }, "conversionRate": { "description": "Conversion rate percentage", "type": "string" }, "failureRate": { "description": "Failure rate percentage", "type": "string" } }, "required": [ "totalCustomers", "completed", "failed", "pending", "conversionRate", "failureRate" ], "additionalProperties": false }, "outreachOverview": { "type": "object", "properties": { "readyNow": { "description": "Customers ready for outreach now", "type": "number" }, "inProgress": { "description": "Customers currently being worked", "type": "number" }, "completed": { "description": "Customers who already reached the goal", "type": "number" }, "needsAttention": { "description": "Customers that may need review", "type": "number" }, "attentionBreakdown": { "type": "object", "properties": { "unsuccessful": { "description": "Customers with unsuccessful or exhausted outcomes", "type": "number" }, "stalled": { "description": "Customers that have not progressed recently", "type": "number" } }, "required": [ "unsuccessful", "stalled" ], "additionalProperties": false } }, "required": [ "readyNow", "inProgress", "completed", "needsAttention", "attentionBreakdown" ], "additionalProperties": false } }, "required": [ "campaignId", "totalCustomers", "statusDistribution", "pendingBreakdown", "successBreakdown", "attemptDistribution", "failureReasons", "exitsByCall", "successByCall", "missingRequiredFields", "summary", "outreachOverview" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdStatsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CampaignsCampaignIdParameterWithClient": { "description": "Include client information in response", "format": "boolean (preprocessed)" }, "GetV2CampaignsCampaignIdPositiveResponse": { "type": "object", "properties": { "campaign": { "description": "Campaign data", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "configurationRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startDate": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "dialAfterhours": { "type": [ "boolean", "null" ] }, "primaryVoicemailGreeting": { "type": [ "string", "null" ] }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ] }, "name": { "type": "string", "maxLength": 255 }, "templateId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "templateName": { "type": [ "string", "null" ] }, "lastModifiedByName": { "type": [ "string", "null" ] }, "lastModifiedByIsStaff": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "tags": { "default": [], "type": "array", "items": { "type": "string" } }, "isReceptionist": { "type": "boolean" }, "isSample": { "description": "The campaign walkthrough's practice campaign. It can't go live and is removed when the walkthrough ends.", "type": "boolean" }, "callerIdSource": { "type": "string", "enum": [ "client_main", "campaign_pool" ] }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "completed", "archived", "cancelled" ] }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "pulseWorkflowId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "maxConcurrentCalls": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 9007199254740991 }, "vertical": { "type": [ "string", "null" ], "enum": [ "aca", "medicare", "hospital_indemnity", "home_health_care", "final_expense", null ] }, "kind": { "default": "voice_ai", "type": "string", "enum": [ "voice_ai", "agent_first" ] }, "dialerConfig": { "description": "Agent-first campaign voicemail defaults", "type": [ "object", "null" ], "properties": { "voicemailMessage": { "type": "string", "maxLength": 1000 }, "dialingRatio": { "description": "Agent-first dials allowed per ready agent. 1 = progressive (default). Values above 1 over-dial to offset unanswered calls and can produce abandoned calls.", "type": "number", "minimum": 1, "maximum": 3 } }, "additionalProperties": false }, "compatibilityWarnings": { "default": [], "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "appointment_fallback_ignored_for_agent_first", "agent_first_callback_ignored_for_voice_ai" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "smsCompanyName": { "description": "Client company name for SMS", "type": "string" }, "requiredVars": { "default": [], "type": "array", "items": { "type": "string" } }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "smsCompanyName": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "hasInquiryCallback": { "description": "Whether campaign has inquiry callback assistant", "type": "boolean" }, "customerStats": { "type": "object", "properties": { "total": { "description": "Total customers in campaign", "type": "number" }, "totalCalls": { "description": "Total calls made", "type": "number" }, "todayCalls": { "description": "Calls made today", "type": "number" }, "todayInboundCalls": { "description": "Inbound calls today", "type": "number" }, "todayOutboundCalls": { "description": "Outbound calls today", "type": "number" }, "todayConnectRate": { "type": [ "number", "null" ] }, "todayDurationMs": { "description": "Total call duration today in ms", "type": "number" }, "statusCounts": { "type": "object", "properties": { "expired": { "type": "number" }, "failed": { "type": "number" }, "pending": { "type": "number" }, "completed": { "type": "number" }, "exceeded_max_calls": { "type": "number" }, "in_progress": { "type": "number" }, "cancelled": { "type": "number" }, "skipped": { "type": "number" } }, "required": [ "expired", "failed", "pending", "completed", "exceeded_max_calls", "in_progress", "cancelled", "skipped" ], "additionalProperties": false } }, "required": [ "total", "totalCalls", "todayCalls", "todayInboundCalls", "todayOutboundCalls", "todayConnectRate", "todayDurationMs", "statusCounts" ], "additionalProperties": false }, "transferConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } }, "additionalProperties": false }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ], "additionalProperties": false } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Transfer config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Transfer config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "compatibilityWarnings": { "default": [], "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "appointment_fallback_ignored_for_agent_first", "agent_first_callback_ignored_for_voice_ai" ] }, "message": { "type": "string" }, "campaignId": { "type": "string" }, "campaignName": { "type": "string" }, "campaignKind": { "type": "string", "enum": [ "voice_ai", "agent_first" ] } }, "required": [ "code", "message" ], "additionalProperties": false } }, "assignedCampaignCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" }, "routingConfig": { "description": "Reference to the assigned routing config. Campaign responses carry only id and name; fetch the full config (agents, groups, routing rules) from the transfer-configs endpoints.", "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "clientId", "name", "description", "configuration", "routingConfigId", "appointmentConfigId", "callFormId", "createdAt", "updatedAt", "compatibilityWarnings", "routingConfig" ], "additionalProperties": false }, "transferConfigIds": { "description": "Campaign-assigned transfer config IDs", "default": [], "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Calendar creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Calendar last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentLength": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentSpacing": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxOptions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "minHours": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ], "additionalProperties": false }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ], "additionalProperties": false } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ], "additionalProperties": false } }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "activeBookingLinkCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "upcomingAppointmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedByScenarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "assignedCampaignCount": { "type": "number" }, "assignedTransferConfigCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByTransferConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "concurrentLimit", "appointmentLength", "appointmentSpacing", "maxOptions", "minDate", "maxDate", "minHours", "preferredMode", "appointmentMode", "showCallerIdOnBookingPage", "assignmentMode", "routingConfigId", "transferConfigId", "workflows", "bookingHours", "createdBy", "updatedBy" ], "additionalProperties": false }, "campaignAutomations": { "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "triggerType": { "type": "string", "enum": [ "lead_created", "customer_created", "policy_created", "policy_status_changed", "campaign_completed", "campaign_failed", "temporal", "date_of_birth", "day_of_year", "policy_changed", "customer_field_changed", "time_in_campaign", "task_completed" ] }, "triggerConfig": { "anyOf": [ { "type": "object", "properties": { "dateField": { "type": "string", "enum": [ "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "paidThroughDate", "gracePeriodStartDate" ] }, "offsetDays": { "type": "integer", "minimum": 0, "maximum": 365 }, "direction": { "type": "string", "enum": [ "before", "after" ] } }, "required": [ "dateField", "offsetDays", "direction" ], "additionalProperties": false }, { "type": "object", "properties": { "offsetDays": { "type": "integer", "minimum": 0, "maximum": 365 }, "direction": { "type": "string", "enum": [ "before", "after" ] }, "atAge": { "type": "integer", "minimum": 0, "maximum": 120 } }, "required": [ "offsetDays", "direction" ], "additionalProperties": false }, { "type": "object", "properties": { "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "day": { "type": "integer", "minimum": 1, "maximum": 31 } }, "required": [ "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "days": { "type": "integer", "minimum": 1, "maximum": 3650 }, "sourceCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "days" ], "additionalProperties": false }, { "type": "object", "properties": { "sourceCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "sourceCampaignId" ], "additionalProperties": false }, { "type": "object", "properties": { "tagName": { "type": "string", "minLength": 1 }, "taskStatus": { "type": "string", "enum": [ "done", "cancelled" ] }, "policyStatusFilter": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved" ] } } }, "required": [ "tagName", "taskStatus" ], "additionalProperties": false }, { "type": "object", "properties": { "fromStatus": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] }, "toStatus": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] }, "fromStatuses": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] } }, "toStatuses": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] } } }, "additionalProperties": false }, { "type": "object", "properties": { "filters": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "const": "state" }, "operator": { "type": "string", "const": "equals" }, "value": { "anyOf": [ { "type": "string", "minLength": 1 }, { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } ] } }, "required": [ "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string", "const": "source" }, "operator": { "type": "string", "const": "equals" }, "value": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ] } }, "required": [ "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string", "const": "custom_field" }, "operator": { "type": "string", "const": "equals" }, "fieldKey": { "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "fieldKey", "value" ], "additionalProperties": false } ] } } }, "additionalProperties": false } ] }, "isActive": { "type": "boolean" }, "targetCampaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "relation": { "type": "string", "enum": [ "target", "source", "exit" ] } }, "required": [ "id", "name", "triggerType", "isActive", "targetCampaignId", "relation" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "configurationRevision", "startDate", "endDate", "dialAfterhours", "name", "templateId", "description", "tags", "isReceptionist", "isSample", "callerIdSource", "status", "direction", "maxConcurrentCalls", "kind", "compatibilityWarnings", "smsCompanyName", "requiredVars", "client", "hasInquiryCallback", "customerStats", "transferConfig", "transferConfigIds", "appointmentConfig", "campaignAutomations" ], "additionalProperties": false }, "assistants": { "description": "Campaign assistants", "default": [], "type": "array", "items": { "type": "object", "properties": { "assistantId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": [ "string", "null" ] }, "language": { "type": "string" }, "enabled": { "type": [ "boolean", "null" ] } }, "required": [ "assistantId", "name", "type", "language", "enabled" ], "additionalProperties": {} } } }, "required": [ "campaign", "assistants" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsCampaignIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdParameterCampaignId": { "description": "Campaign ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CampaignsCampaignIdPositiveResponse": { "type": "object", "properties": { "campaign": { "description": "Updated campaign data", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "configurationRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startDate": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "dialAfterhours": { "type": [ "boolean", "null" ] }, "primaryVoicemailGreeting": { "type": [ "string", "null" ] }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ] }, "name": { "type": "string", "maxLength": 255 }, "templateId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "templateName": { "type": [ "string", "null" ] }, "lastModifiedByName": { "type": [ "string", "null" ] }, "lastModifiedByIsStaff": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "tags": { "default": [], "type": "array", "items": { "type": "string" } }, "isReceptionist": { "type": "boolean" }, "isSample": { "description": "The campaign walkthrough's practice campaign. It can't go live and is removed when the walkthrough ends.", "type": "boolean" }, "callerIdSource": { "type": "string", "enum": [ "client_main", "campaign_pool" ] }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "completed", "archived", "cancelled" ] }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "pulseWorkflowId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "maxConcurrentCalls": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 9007199254740991 }, "vertical": { "type": [ "string", "null" ], "enum": [ "aca", "medicare", "hospital_indemnity", "home_health_care", "final_expense", null ] }, "kind": { "default": "voice_ai", "type": "string", "enum": [ "voice_ai", "agent_first" ] }, "dialerConfig": { "description": "Agent-first campaign voicemail defaults", "type": [ "object", "null" ], "properties": { "voicemailMessage": { "type": "string", "maxLength": 1000 }, "dialingRatio": { "description": "Agent-first dials allowed per ready agent. 1 = progressive (default). Values above 1 over-dial to offset unanswered calls and can produce abandoned calls.", "type": "number", "minimum": 1, "maximum": 3 } }, "additionalProperties": false }, "compatibilityWarnings": { "default": [], "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "appointment_fallback_ignored_for_agent_first", "agent_first_callback_ignored_for_voice_ai" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "smsCompanyName": { "description": "Client company name for SMS", "type": "string" }, "requiredVars": { "default": [], "type": "array", "items": { "type": "string" } }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "smsCompanyName": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "hasInquiryCallback": { "description": "Whether campaign has inquiry callback assistant", "type": "boolean" }, "customerStats": { "type": "object", "properties": { "total": { "description": "Total customers in campaign", "type": "number" }, "totalCalls": { "description": "Total calls made", "type": "number" }, "todayCalls": { "description": "Calls made today", "type": "number" }, "todayInboundCalls": { "description": "Inbound calls today", "type": "number" }, "todayOutboundCalls": { "description": "Outbound calls today", "type": "number" }, "todayConnectRate": { "type": [ "number", "null" ] }, "todayDurationMs": { "description": "Total call duration today in ms", "type": "number" }, "statusCounts": { "type": "object", "properties": { "expired": { "type": "number" }, "failed": { "type": "number" }, "pending": { "type": "number" }, "completed": { "type": "number" }, "exceeded_max_calls": { "type": "number" }, "in_progress": { "type": "number" }, "cancelled": { "type": "number" }, "skipped": { "type": "number" } }, "required": [ "expired", "failed", "pending", "completed", "exceeded_max_calls", "in_progress", "cancelled", "skipped" ], "additionalProperties": false } }, "required": [ "total", "totalCalls", "todayCalls", "todayInboundCalls", "todayOutboundCalls", "todayConnectRate", "todayDurationMs", "statusCounts" ], "additionalProperties": false }, "transferConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } }, "additionalProperties": false }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ], "additionalProperties": false } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Transfer config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Transfer config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "compatibilityWarnings": { "default": [], "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "appointment_fallback_ignored_for_agent_first", "agent_first_callback_ignored_for_voice_ai" ] }, "message": { "type": "string" }, "campaignId": { "type": "string" }, "campaignName": { "type": "string" }, "campaignKind": { "type": "string", "enum": [ "voice_ai", "agent_first" ] } }, "required": [ "code", "message" ], "additionalProperties": false } }, "assignedCampaignCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" }, "routingConfig": { "description": "Reference to the assigned routing config. Campaign responses carry only id and name; fetch the full config (agents, groups, routing rules) from the transfer-configs endpoints.", "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "clientId", "name", "description", "configuration", "routingConfigId", "appointmentConfigId", "callFormId", "createdAt", "updatedAt", "compatibilityWarnings", "routingConfig" ], "additionalProperties": false }, "transferConfigIds": { "description": "Campaign-assigned transfer config IDs", "default": [], "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Calendar creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Calendar last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentLength": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentSpacing": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxOptions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "minHours": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ], "additionalProperties": false }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ], "additionalProperties": false } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ], "additionalProperties": false } }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "activeBookingLinkCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "upcomingAppointmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedByScenarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "assignedCampaignCount": { "type": "number" }, "assignedTransferConfigCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByTransferConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "concurrentLimit", "appointmentLength", "appointmentSpacing", "maxOptions", "minDate", "maxDate", "minHours", "preferredMode", "appointmentMode", "showCallerIdOnBookingPage", "assignmentMode", "routingConfigId", "transferConfigId", "workflows", "bookingHours", "createdBy", "updatedBy" ], "additionalProperties": false }, "campaignAutomations": { "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "triggerType": { "type": "string", "enum": [ "lead_created", "customer_created", "policy_created", "policy_status_changed", "campaign_completed", "campaign_failed", "temporal", "date_of_birth", "day_of_year", "policy_changed", "customer_field_changed", "time_in_campaign", "task_completed" ] }, "triggerConfig": { "anyOf": [ { "type": "object", "properties": { "dateField": { "type": "string", "enum": [ "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "paidThroughDate", "gracePeriodStartDate" ] }, "offsetDays": { "type": "integer", "minimum": 0, "maximum": 365 }, "direction": { "type": "string", "enum": [ "before", "after" ] } }, "required": [ "dateField", "offsetDays", "direction" ], "additionalProperties": false }, { "type": "object", "properties": { "offsetDays": { "type": "integer", "minimum": 0, "maximum": 365 }, "direction": { "type": "string", "enum": [ "before", "after" ] }, "atAge": { "type": "integer", "minimum": 0, "maximum": 120 } }, "required": [ "offsetDays", "direction" ], "additionalProperties": false }, { "type": "object", "properties": { "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "day": { "type": "integer", "minimum": 1, "maximum": 31 } }, "required": [ "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "days": { "type": "integer", "minimum": 1, "maximum": 3650 }, "sourceCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "days" ], "additionalProperties": false }, { "type": "object", "properties": { "sourceCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "sourceCampaignId" ], "additionalProperties": false }, { "type": "object", "properties": { "tagName": { "type": "string", "minLength": 1 }, "taskStatus": { "type": "string", "enum": [ "done", "cancelled" ] }, "policyStatusFilter": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved" ] } } }, "required": [ "tagName", "taskStatus" ], "additionalProperties": false }, { "type": "object", "properties": { "fromStatus": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] }, "toStatus": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] }, "fromStatuses": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] } }, "toStatuses": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] } } }, "additionalProperties": false }, { "type": "object", "properties": { "filters": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "const": "state" }, "operator": { "type": "string", "const": "equals" }, "value": { "anyOf": [ { "type": "string", "minLength": 1 }, { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } ] } }, "required": [ "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string", "const": "source" }, "operator": { "type": "string", "const": "equals" }, "value": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ] } }, "required": [ "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string", "const": "custom_field" }, "operator": { "type": "string", "const": "equals" }, "fieldKey": { "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "fieldKey", "value" ], "additionalProperties": false } ] } } }, "additionalProperties": false } ] }, "isActive": { "type": "boolean" }, "targetCampaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "relation": { "type": "string", "enum": [ "target", "source", "exit" ] } }, "required": [ "id", "name", "triggerType", "isActive", "targetCampaignId", "relation" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "configurationRevision", "startDate", "endDate", "dialAfterhours", "name", "templateId", "description", "tags", "isReceptionist", "isSample", "callerIdSource", "status", "direction", "maxConcurrentCalls", "kind", "compatibilityWarnings", "smsCompanyName", "requiredVars", "client", "hasInquiryCallback", "customerStats", "transferConfig", "transferConfigIds", "appointmentConfig", "campaignAutomations" ], "additionalProperties": false } }, "required": [ "campaign" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CampaignsCampaignIdRequestBody": { "type": "object", "properties": { "callerIdSource": { "type": "string", "enum": [ "client_main", "campaign_pool" ] }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "completed", "archived", "cancelled" ] }, "maxConcurrentCalls": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 9007199254740991 }, "pulseWorkflowId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "endDate": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "tags": { "type": "array", "items": { "type": "string" } }, "kind": { "type": "string", "enum": [ "voice_ai", "agent_first" ] }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 4000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 4000 }, "smsCompanyName": { "type": "string" }, "dialerConfig": { "type": [ "object", "null" ], "properties": { "voicemailMessage": { "type": "string", "maxLength": 1000 }, "dialingRatio": { "description": "Agent-first dials allowed per ready agent. 1 = progressive (default). Values above 1 over-dial to offset unanswered calls and can produce abandoned calls.", "type": "number", "minimum": 1, "maximum": 3 } }, "additionalProperties": false }, "expectedConfigurationRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "expectedUpdatedAt": { "description": "Campaign revision read before editing. Stale revisions return HTTP 409.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "transferConfigIds": { "description": "Campaign-assigned transfer configs. Ordered list, first item is default.", "type": [ "array", "null" ], "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [], "additionalProperties": false }, "GetV2CampaignsParameterPage": { "default": 1, "type": "number", "minimum": 1 }, "GetV2CampaignsParameterPerPage": { "default": 50, "type": "number", "minimum": 1, "maximum": 100 }, "GetV2CampaignsParameterIncludeReceptionist": { "description": "Include the organization receptionist in configuration listings. Receptionists cannot be assigned sources.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CampaignsParameterSortBy": { "description": "Field to sort by", "default": "createdAt", "type": "string", "enum": [ "createdAt", "updatedAt", "name", "status", "startDate", "todayCalls" ] }, "GetV2CampaignsParameterSortDirection": { "description": "Sort direction", "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "GetV2CampaignsParameterSearch": { "description": "Search query for filtering campaigns by name or description", "type": "string" }, "GetV2CampaignsParameterStatus": { "description": "Filter campaigns by status", "type": "string", "enum": [ "draft", "active", "paused", "completed", "archived", "cancelled" ] }, "GetV2CampaignsParameterKind": { "description": "Filter by campaign kind. 'voice_ai' returns voice-AI campaigns (and legacy null-kind); 'agent_first' returns agent-first dialers/desks.", "type": "string", "enum": [ "voice_ai", "agent_first" ] }, "GetV2CampaignsPositiveResponse": { "type": "object", "properties": { "itemsTotal": { "type": "number" }, "currentPage": { "type": "number" }, "nextPage": { "type": [ "number", "null" ] }, "prevPage": { "type": [ "number", "null" ] }, "items": { "description": "Array of campaigns", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "configurationRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startDate": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "dialAfterhours": { "type": [ "boolean", "null" ] }, "primaryVoicemailGreeting": { "type": [ "string", "null" ] }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ] }, "name": { "type": "string", "maxLength": 255 }, "templateId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "templateName": { "type": [ "string", "null" ] }, "lastModifiedByName": { "type": [ "string", "null" ] }, "lastModifiedByIsStaff": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "tags": { "default": [], "type": "array", "items": { "type": "string" } }, "isReceptionist": { "type": "boolean" }, "isSample": { "description": "The campaign walkthrough's practice campaign. It can't go live and is removed when the walkthrough ends.", "type": "boolean" }, "callerIdSource": { "type": "string", "enum": [ "client_main", "campaign_pool" ] }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "completed", "archived", "cancelled" ] }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "pulseWorkflowId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "maxConcurrentCalls": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 9007199254740991 }, "vertical": { "type": [ "string", "null" ], "enum": [ "aca", "medicare", "hospital_indemnity", "home_health_care", "final_expense", null ] }, "kind": { "default": "voice_ai", "type": "string", "enum": [ "voice_ai", "agent_first" ] }, "dialerConfig": { "description": "Agent-first campaign voicemail defaults", "type": [ "object", "null" ], "properties": { "voicemailMessage": { "type": "string", "maxLength": 1000 }, "dialingRatio": { "description": "Agent-first dials allowed per ready agent. 1 = progressive (default). Values above 1 over-dial to offset unanswered calls and can produce abandoned calls.", "type": "number", "minimum": 1, "maximum": 3 } }, "additionalProperties": false }, "compatibilityWarnings": { "default": [], "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "appointment_fallback_ignored_for_agent_first", "agent_first_callback_ignored_for_voice_ai" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "smsCompanyName": { "description": "Client company name for SMS", "type": "string" }, "requiredVars": { "default": [], "type": "array", "items": { "type": "string" } }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "smsCompanyName": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "hasInquiryCallback": { "description": "Whether campaign has inquiry callback assistant", "type": "boolean" }, "customerStats": { "type": "object", "properties": { "total": { "description": "Total customers in campaign", "type": "number" }, "totalCalls": { "description": "Total calls made", "type": "number" }, "todayCalls": { "description": "Calls made today", "type": "number" }, "todayInboundCalls": { "description": "Inbound calls today", "type": "number" }, "todayOutboundCalls": { "description": "Outbound calls today", "type": "number" }, "todayConnectRate": { "type": [ "number", "null" ] }, "todayDurationMs": { "description": "Total call duration today in ms", "type": "number" }, "statusCounts": { "type": "object", "properties": { "expired": { "type": "number" }, "failed": { "type": "number" }, "pending": { "type": "number" }, "completed": { "type": "number" }, "exceeded_max_calls": { "type": "number" }, "in_progress": { "type": "number" }, "cancelled": { "type": "number" }, "skipped": { "type": "number" } }, "required": [ "expired", "failed", "pending", "completed", "exceeded_max_calls", "in_progress", "cancelled", "skipped" ], "additionalProperties": false } }, "required": [ "total", "totalCalls", "todayCalls", "todayInboundCalls", "todayOutboundCalls", "todayConnectRate", "todayDurationMs", "statusCounts" ], "additionalProperties": false }, "transferConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } }, "additionalProperties": false }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ], "additionalProperties": false } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Transfer config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Transfer config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "compatibilityWarnings": { "default": [], "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "appointment_fallback_ignored_for_agent_first", "agent_first_callback_ignored_for_voice_ai" ] }, "message": { "type": "string" }, "campaignId": { "type": "string" }, "campaignName": { "type": "string" }, "campaignKind": { "type": "string", "enum": [ "voice_ai", "agent_first" ] } }, "required": [ "code", "message" ], "additionalProperties": false } }, "assignedCampaignCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" }, "routingConfig": { "description": "Reference to the assigned routing config. Campaign responses carry only id and name; fetch the full config (agents, groups, routing rules) from the transfer-configs endpoints.", "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "clientId", "name", "description", "configuration", "routingConfigId", "appointmentConfigId", "callFormId", "createdAt", "updatedAt", "compatibilityWarnings", "routingConfig" ], "additionalProperties": false }, "transferConfigIds": { "description": "Campaign-assigned transfer config IDs", "default": [], "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Calendar creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Calendar last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentLength": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentSpacing": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxOptions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "minHours": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ], "additionalProperties": false }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ], "additionalProperties": false } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ], "additionalProperties": false } }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "activeBookingLinkCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "upcomingAppointmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedByScenarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "assignedCampaignCount": { "type": "number" }, "assignedTransferConfigCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByTransferConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "concurrentLimit", "appointmentLength", "appointmentSpacing", "maxOptions", "minDate", "maxDate", "minHours", "preferredMode", "appointmentMode", "showCallerIdOnBookingPage", "assignmentMode", "routingConfigId", "transferConfigId", "workflows", "bookingHours", "createdBy", "updatedBy" ], "additionalProperties": false }, "campaignAutomations": { "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "triggerType": { "type": "string", "enum": [ "lead_created", "customer_created", "policy_created", "policy_status_changed", "campaign_completed", "campaign_failed", "temporal", "date_of_birth", "day_of_year", "policy_changed", "customer_field_changed", "time_in_campaign", "task_completed" ] }, "triggerConfig": { "anyOf": [ { "type": "object", "properties": { "dateField": { "type": "string", "enum": [ "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "paidThroughDate", "gracePeriodStartDate" ] }, "offsetDays": { "type": "integer", "minimum": 0, "maximum": 365 }, "direction": { "type": "string", "enum": [ "before", "after" ] } }, "required": [ "dateField", "offsetDays", "direction" ], "additionalProperties": false }, { "type": "object", "properties": { "offsetDays": { "type": "integer", "minimum": 0, "maximum": 365 }, "direction": { "type": "string", "enum": [ "before", "after" ] }, "atAge": { "type": "integer", "minimum": 0, "maximum": 120 } }, "required": [ "offsetDays", "direction" ], "additionalProperties": false }, { "type": "object", "properties": { "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "day": { "type": "integer", "minimum": 1, "maximum": 31 } }, "required": [ "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "days": { "type": "integer", "minimum": 1, "maximum": 3650 }, "sourceCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "days" ], "additionalProperties": false }, { "type": "object", "properties": { "sourceCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "sourceCampaignId" ], "additionalProperties": false }, { "type": "object", "properties": { "tagName": { "type": "string", "minLength": 1 }, "taskStatus": { "type": "string", "enum": [ "done", "cancelled" ] }, "policyStatusFilter": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved" ] } } }, "required": [ "tagName", "taskStatus" ], "additionalProperties": false }, { "type": "object", "properties": { "fromStatus": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] }, "toStatus": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] }, "fromStatuses": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] } }, "toStatuses": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] } } }, "additionalProperties": false }, { "type": "object", "properties": { "filters": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "const": "state" }, "operator": { "type": "string", "const": "equals" }, "value": { "anyOf": [ { "type": "string", "minLength": 1 }, { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } ] } }, "required": [ "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string", "const": "source" }, "operator": { "type": "string", "const": "equals" }, "value": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ] } }, "required": [ "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string", "const": "custom_field" }, "operator": { "type": "string", "const": "equals" }, "fieldKey": { "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "fieldKey", "value" ], "additionalProperties": false } ] } } }, "additionalProperties": false } ] }, "isActive": { "type": "boolean" }, "targetCampaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "relation": { "type": "string", "enum": [ "target", "source", "exit" ] } }, "required": [ "id", "name", "triggerType", "isActive", "targetCampaignId", "relation" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "configurationRevision", "startDate", "endDate", "dialAfterhours", "name", "templateId", "description", "tags", "isReceptionist", "isSample", "callerIdSource", "status", "direction", "maxConcurrentCalls", "kind", "compatibilityWarnings", "smsCompanyName", "requiredVars", "client", "hasInquiryCallback", "customerStats", "transferConfig", "transferConfigIds", "appointmentConfig", "campaignAutomations" ], "additionalProperties": false } } }, "required": [ "itemsTotal", "currentPage", "nextPage", "prevPage", "items" ], "additionalProperties": false }, "GetV2CampaignsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CampaignsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CampaignsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsPositiveResponse": { "type": "object", "properties": { "campaign": { "description": "Created campaign data", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "configurationRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startDate": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endDate": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "dialAfterhours": { "type": [ "boolean", "null" ] }, "primaryVoicemailGreeting": { "type": [ "string", "null" ] }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ] }, "name": { "type": "string", "maxLength": 255 }, "templateId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "templateName": { "type": [ "string", "null" ] }, "lastModifiedByName": { "type": [ "string", "null" ] }, "lastModifiedByIsStaff": { "type": "boolean" }, "description": { "type": [ "string", "null" ] }, "tags": { "default": [], "type": "array", "items": { "type": "string" } }, "isReceptionist": { "type": "boolean" }, "isSample": { "description": "The campaign walkthrough's practice campaign. It can't go live and is removed when the walkthrough ends.", "type": "boolean" }, "callerIdSource": { "type": "string", "enum": [ "client_main", "campaign_pool" ] }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "completed", "archived", "cancelled" ] }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "pulseWorkflowId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "maxConcurrentCalls": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 9007199254740991 }, "vertical": { "type": [ "string", "null" ], "enum": [ "aca", "medicare", "hospital_indemnity", "home_health_care", "final_expense", null ] }, "kind": { "default": "voice_ai", "type": "string", "enum": [ "voice_ai", "agent_first" ] }, "dialerConfig": { "description": "Agent-first campaign voicemail defaults", "type": [ "object", "null" ], "properties": { "voicemailMessage": { "type": "string", "maxLength": 1000 }, "dialingRatio": { "description": "Agent-first dials allowed per ready agent. 1 = progressive (default). Values above 1 over-dial to offset unanswered calls and can produce abandoned calls.", "type": "number", "minimum": 1, "maximum": 3 } }, "additionalProperties": false }, "compatibilityWarnings": { "default": [], "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "appointment_fallback_ignored_for_agent_first", "agent_first_callback_ignored_for_voice_ai" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "smsCompanyName": { "description": "Client company name for SMS", "type": "string" }, "requiredVars": { "default": [], "type": "array", "items": { "type": "string" } }, "client": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "smsCompanyName": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "hasInquiryCallback": { "description": "Whether campaign has inquiry callback assistant", "type": "boolean" }, "customerStats": { "type": "object", "properties": { "total": { "description": "Total customers in campaign", "type": "number" }, "totalCalls": { "description": "Total calls made", "type": "number" }, "todayCalls": { "description": "Calls made today", "type": "number" }, "todayInboundCalls": { "description": "Inbound calls today", "type": "number" }, "todayOutboundCalls": { "description": "Outbound calls today", "type": "number" }, "todayConnectRate": { "type": [ "number", "null" ] }, "todayDurationMs": { "description": "Total call duration today in ms", "type": "number" }, "statusCounts": { "type": "object", "properties": { "expired": { "type": "number" }, "failed": { "type": "number" }, "pending": { "type": "number" }, "completed": { "type": "number" }, "exceeded_max_calls": { "type": "number" }, "in_progress": { "type": "number" }, "cancelled": { "type": "number" }, "skipped": { "type": "number" } }, "required": [ "expired", "failed", "pending", "completed", "exceeded_max_calls", "in_progress", "cancelled", "skipped" ], "additionalProperties": false } }, "required": [ "total", "totalCalls", "todayCalls", "todayInboundCalls", "todayOutboundCalls", "todayConnectRate", "todayDurationMs", "statusCounts" ], "additionalProperties": false }, "transferConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "configuration": { "type": "object", "properties": { "version": { "type": "number", "const": 2 }, "destination": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "drafts": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "type": { "type": "string", "const": "direct" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "phoneNumber", "externalHandoff" ], "additionalProperties": false }, "dynamic": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "pingUrl": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "timeout": { "type": "integer", "minimum": 1, "maximum": 30000 }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "body": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "transferNumberField": { "type": "string" }, "transferNumber": { "type": "string" }, "successConditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "greater_than", "not_equals", "contains" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "fallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "fallback", "externalHandoff" ], "additionalProperties": false }, "sip": { "type": "object", "properties": { "type": { "type": "string", "const": "sip" }, "uri": { "type": [ "string", "null" ], "maxLength": 2048 }, "headers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256, "pattern": "^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$" }, "additionalProperties": { "type": "string", "maxLength": 2048 } }, "externalHandoff": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "cold", "warm" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "type", "uri", "headers", "externalHandoff" ], "additionalProperties": false }, "softphone": { "type": "object", "properties": { "type": { "type": "string", "const": "softphone" }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "handoffStrategy": { "type": "string", "enum": [ "wait-for-operator", "immediate-transfer" ] }, "voiceAiFallback": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "none" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "phone_number" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 20, "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "type", "phoneNumber" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "appointment_booking" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "type", "appointmentConfigId" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } }, "agentWorkspace": { "type": "object", "properties": { "screenBehavior": { "type": "string", "enum": [ "call-form", "customer-details", "inbox", "none" ] }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "screenBehavior", "callFormId" ], "additionalProperties": false }, "agentFirstHandling": { "type": "object", "properties": { "callback": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "abandonOfferEnabled": { "type": "boolean" }, "aiOfferEnabled": { "type": "boolean" }, "expiryMinutes": { "type": "integer", "minimum": 15, "maximum": 480 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "retryDelayMinutes": { "type": "integer", "minimum": 1, "maximum": 60 }, "closeBufferMinutes": { "type": "integer", "minimum": 5, "maximum": 120 } }, "additionalProperties": false }, "primaryVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 }, "afterHoursVoicemailGreeting": { "type": [ "string", "null" ], "maxLength": 1000 } }, "additionalProperties": false } }, "required": [ "type", "routingConfigId", "handoffStrategy", "voiceAiFallback", "agentWorkspace", "agentFirstHandling" ], "additionalProperties": false } }, "additionalProperties": false }, "warmTransfer": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "wait-for-operator", "immediate-summary" ] }, "summaryPrompt": { "type": [ "string", "null" ] } }, "required": [ "mode", "summaryPrompt" ], "additionalProperties": false } }, "required": [ "version", "destination", "drafts", "warmTransfer" ], "additionalProperties": false }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Transfer config creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Transfer config last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "compatibilityWarnings": { "default": [], "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "appointment_fallback_ignored_for_agent_first", "agent_first_callback_ignored_for_voice_ai" ] }, "message": { "type": "string" }, "campaignId": { "type": "string" }, "campaignName": { "type": "string" }, "campaignKind": { "type": "string", "enum": [ "voice_ai", "agent_first" ] } }, "required": [ "code", "message" ], "additionalProperties": false } }, "assignedCampaignCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" }, "routingConfig": { "description": "Reference to the assigned routing config. Campaign responses carry only id and name; fetch the full config (agents, groups, routing rules) from the transfer-configs endpoints.", "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "clientId", "name", "description", "configuration", "routingConfigId", "appointmentConfigId", "callFormId", "createdAt", "updatedAt", "compatibilityWarnings", "routingConfig" ], "additionalProperties": false }, "transferConfigIds": { "description": "Campaign-assigned transfer config IDs", "default": [], "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "callFormId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "appointmentConfig": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Calendar creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Calendar last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "concurrentLimit": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentLength": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "appointmentSpacing": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "maxOptions": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "minDate": { "description": "Earliest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "maxDate": { "description": "Latest appointment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "minHours": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "preferredMode": { "type": "string", "enum": [ "timezone", "zipcode" ] }, "appointmentMode": { "type": "string", "enum": [ "phone_call", "in_person", "video_call", "agent_phone_call" ] }, "showCallerIdOnBookingPage": { "type": "boolean" }, "assignmentMode": { "type": "string", "enum": [ "customer_agent", "routing_config", "external_transfer" ] }, "routingConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "trigger": { "type": "object", "properties": { "anchor": { "type": "string", "enum": [ "event_starts", "event_ends" ] }, "offsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "anchor", "offsetMinutes" ], "additionalProperties": false }, "condition": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "appointment_status" }, "statuses": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "scheduled", "confirmed", "cancelled", "completed", "no_show" ] } } }, "required": [ "kind", "statuses" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "action": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "sms" }, "senderId": { "type": [ "string", "null" ] }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "email" }, "senderId": { "type": [ "string", "null" ] }, "subject": { "type": "string", "minLength": 1 }, "template": { "type": "string", "minLength": 1 } }, "required": [ "type", "subject", "template" ], "additionalProperties": false } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "enabled", "trigger", "action" ], "additionalProperties": false } }, "bookingHours": { "type": "array", "items": { "type": "object", "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23 }, "startMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endMinute": { "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "minItems": 1, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 } } }, "required": [ "startHour", "endHour", "dayOfWeek" ], "additionalProperties": false } }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "usageHash": { "type": "string" }, "usedByResources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer", "appointment", "scenario" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "kind", "id", "name" ], "additionalProperties": false } }, "activeBookingLinkCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "upcomingAppointmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedByScenarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "message": { "type": "string" } }, "required": [ "section", "message" ], "additionalProperties": false } } }, "required": [ "ready", "issues" ], "additionalProperties": false }, "assignedCampaignCount": { "type": "number" }, "assignedTransferConfigCount": { "type": "number" }, "usedByCampaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "status" ], "additionalProperties": false } }, "usedByTransferConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "usedByReceptionist": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "name", "description", "concurrentLimit", "appointmentLength", "appointmentSpacing", "maxOptions", "minDate", "maxDate", "minHours", "preferredMode", "appointmentMode", "showCallerIdOnBookingPage", "assignmentMode", "routingConfigId", "transferConfigId", "workflows", "bookingHours", "createdBy", "updatedBy" ], "additionalProperties": false }, "campaignAutomations": { "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "triggerType": { "type": "string", "enum": [ "lead_created", "customer_created", "policy_created", "policy_status_changed", "campaign_completed", "campaign_failed", "temporal", "date_of_birth", "day_of_year", "policy_changed", "customer_field_changed", "time_in_campaign", "task_completed" ] }, "triggerConfig": { "anyOf": [ { "type": "object", "properties": { "dateField": { "type": "string", "enum": [ "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "paidThroughDate", "gracePeriodStartDate" ] }, "offsetDays": { "type": "integer", "minimum": 0, "maximum": 365 }, "direction": { "type": "string", "enum": [ "before", "after" ] } }, "required": [ "dateField", "offsetDays", "direction" ], "additionalProperties": false }, { "type": "object", "properties": { "offsetDays": { "type": "integer", "minimum": 0, "maximum": 365 }, "direction": { "type": "string", "enum": [ "before", "after" ] }, "atAge": { "type": "integer", "minimum": 0, "maximum": 120 } }, "required": [ "offsetDays", "direction" ], "additionalProperties": false }, { "type": "object", "properties": { "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "day": { "type": "integer", "minimum": 1, "maximum": 31 } }, "required": [ "month", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "days": { "type": "integer", "minimum": 1, "maximum": 3650 }, "sourceCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "days" ], "additionalProperties": false }, { "type": "object", "properties": { "sourceCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "sourceCampaignId" ], "additionalProperties": false }, { "type": "object", "properties": { "tagName": { "type": "string", "minLength": 1 }, "taskStatus": { "type": "string", "enum": [ "done", "cancelled" ] }, "policyStatusFilter": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved" ] } } }, "required": [ "tagName", "taskStatus" ], "additionalProperties": false }, { "type": "object", "properties": { "fromStatus": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] }, "toStatus": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] }, "fromStatuses": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] } }, "toStatuses": { "type": "array", "items": { "type": "string", "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", "ANY" ] } } }, "additionalProperties": false }, { "type": "object", "properties": { "filters": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "const": "state" }, "operator": { "type": "string", "const": "equals" }, "value": { "anyOf": [ { "type": "string", "minLength": 1 }, { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } ] } }, "required": [ "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string", "const": "source" }, "operator": { "type": "string", "const": "equals" }, "value": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ] } }, "required": [ "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string", "const": "custom_field" }, "operator": { "type": "string", "const": "equals" }, "fieldKey": { "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "fieldKey", "value" ], "additionalProperties": false } ] } } }, "additionalProperties": false } ] }, "isActive": { "type": "boolean" }, "targetCampaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "relation": { "type": "string", "enum": [ "target", "source", "exit" ] } }, "required": [ "id", "name", "triggerType", "isActive", "targetCampaignId", "relation" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "configurationRevision", "startDate", "endDate", "dialAfterhours", "name", "templateId", "description", "tags", "isReceptionist", "isSample", "callerIdSource", "status", "direction", "maxConcurrentCalls", "kind", "compatibilityWarnings", "smsCompanyName", "requiredVars", "client", "hasInquiryCallback", "customerStats", "transferConfig", "transferConfigIds", "appointmentConfig", "campaignAutomations" ], "additionalProperties": false }, "warnings": { "description": "Creation compatibility notices, including incomplete older template snapshots", "type": "array", "items": { "type": "string" } } }, "required": [ "campaign" ], "additionalProperties": false }, "PostV2CampaignsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CampaignsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CampaignsRequestBody": { "type": "object", "properties": { "callerIdSource": { "type": "string", "enum": [ "client_main", "campaign_pool" ] }, "name": { "description": "Campaign name. A missing or blank name becomes \"Untitled campaign\".", "type": "string", "maxLength": 255 }, "description": { "description": "Campaign description", "type": [ "string", "null" ] }, "templateId": { "description": "Optional campaign template ID", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "maxConcurrentCalls": { "description": "Optional Pulse call concurrency cap for this campaign", "type": [ "integer", "null" ], "minimum": 1, "maximum": 9007199254740991 }, "direction": { "description": "Campaign direction", "type": "string", "enum": [ "inbound", "outbound" ] }, "kind": { "description": "Campaign kind (defaults to voice_ai)", "type": "string", "enum": [ "voice_ai", "agent_first" ] }, "dialerConfig": { "type": [ "object", "null" ], "properties": { "voicemailMessage": { "type": "string", "maxLength": 1000 }, "dialingRatio": { "description": "Agent-first dials allowed per ready agent. 1 = progressive (default). Values above 1 over-dial to offset unanswered calls and can produce abandoned calls.", "type": "number", "minimum": 1, "maximum": 3 } }, "additionalProperties": false } }, "additionalProperties": false }, "GetV2CallsCountParameterSearch": { "description": "Search query: matches customer name, phone number, or disposition", "type": "string" }, "GetV2CallsCountParameterCustomerId": { "description": "Filter calls by customer ID for exact customer call history", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsCountParameterCampaignIds": { "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "type": "string" }, "GetV2CallsCountParameterAgentUserIds": { "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "type": "string" }, "GetV2CallsCountParameterDurationOperator": { "description": "Duration filter operator (less than or equal, greater than or equal)", "type": "string", "enum": [ "<=", ">=" ] }, "GetV2CallsCountParameterDurationValue": { "description": "Duration value in seconds to filter by", "type": "number", "minimum": 0 }, "GetV2CallsCountParameterDirection": { "description": "Filter by call direction", "type": "string", "enum": [ "inbound", "outbound" ] }, "GetV2CallsCountParameterCallType": { "description": "Filter by call type: Voice AI or Softphone", "type": "string", "enum": [ "voice_ai", "softphone" ] }, "GetV2CallsCountParameterStartDate": { "description": "Start date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsCountParameterEndDate": { "description": "End date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsCountParameterExcludeDispositions": { "description": "Array of disposition names to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsCountParameterIncludeDispositions": { "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "type": "string" }, "GetV2CallsCountParameterExcludeSources": { "description": "Array of source ids to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsCountParameterIncludeTestCalls": { "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsCountParameterConnectedCallsOnly": { "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsCountParameterIncludeErrorDispositions": { "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsCountPositiveResponse": { "type": "object", "properties": { "count": { "description": "Total number of calls matching the filters", "type": "number" } }, "required": [ "count" ], "additionalProperties": false }, "GetV2CallsCountNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsCountNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsCountNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsCountNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsCountNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsCountNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsCountNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsCountNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsCountNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsCountNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsAgentsPositiveResponse": { "type": "object", "properties": { "agents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "agents" ], "additionalProperties": false }, "GetV2CallsAgentsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsAgentsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsAgentsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsAgentsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsAgentsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsAgentsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsAgentsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsAgentsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsAgentsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsAgentsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAccessParameterStartDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } ] }, "GetV2CallsMetricsAccessParameterEndDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } ] }, "GetV2CallsMetricsAccessParameterDirection": { "default": "all", "type": "string", "enum": [ "all", "inbound", "outbound" ] }, "GetV2CallsMetricsAccessParameterHandler": { "default": "all", "type": "string", "enum": [ "all", "softphone", "voice_ai" ] }, "GetV2CallsMetricsAccessParameterIntervalMinutes": { "default": 30, "type": "number" }, "GetV2CallsMetricsAccessParameterCampaignIds": { "type": "string" }, "GetV2CallsMetricsAccessParameterTransferConfigIds": { "type": "string" }, "GetV2CallsMetricsAccessParameterAccessPage": { "default": 1, "type": "integer", "minimum": 1, "maximum": 10000 }, "GetV2CallsMetricsAccessParameterAccessOutcome": { "default": "all", "type": "string", "enum": [ "all", "unavailable", "caller_hung_up" ] }, "GetV2CallsMetricsAccessParameterAccessView": { "default": "callers", "type": "string", "enum": [ "callers", "attempts" ] }, "GetV2CallsMetricsAccessParameterAccessCaller": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsMetricsAccessPositiveResponse": { "type": "object", "properties": { "asOf": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "type": "string" }, "observationHours": { "type": "number", "const": 24 }, "summary": { "type": "object", "properties": { "attempts": { "type": "number" }, "uniqueCallers": { "type": "number" }, "repeatAttempts": { "type": "number" }, "anonymousAttempts": { "type": "number" }, "reconnectedCallers": { "type": "number" }, "callbackReconnections": { "type": "number" }, "inboundReconnections": { "type": "number" }, "outboundReconnections": { "type": "number" }, "observingCallers": { "type": "number" }, "noReconnectionWithinWindow": { "type": "number" }, "callerEndedAfterFallback": { "type": "number" }, "platformEndedAfterFallback": { "type": "number" }, "historicalFallbacks": { "type": "number" }, "historicalTerminations": { "type": "number" }, "trackingExceptions": { "type": "number" } }, "required": [ "attempts", "uniqueCallers", "repeatAttempts", "anonymousAttempts", "reconnectedCallers", "callbackReconnections", "inboundReconnections", "outboundReconnections", "observingCallers", "noReconnectionWithinWindow", "callerEndedAfterFallback", "platformEndedAfterFallback", "historicalFallbacks", "historicalTerminations", "trackingExceptions" ], "additionalProperties": false }, "callbackDecisions": { "type": "array", "items": { "type": "object", "properties": { "reason": { "type": "string" }, "count": { "type": "number" } }, "required": [ "reason", "count" ], "additionalProperties": false } }, "callbackPolicies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "id", "name", "enabled" ], "additionalProperties": false } }, "itemsTotal": { "type": "number" }, "page": { "type": "number" }, "perPage": { "type": "number", "const": 25 }, "view": { "type": "string", "enum": [ "callers", "attempts" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "outcome": { "type": "string" }, "agentConnectedAt": { "type": [ "string", "null" ] }, "queuedAt": { "type": [ "string", "null" ] }, "fallbackReason": { "type": [ "string", "null" ] }, "fallbackAction": { "type": [ "string", "null" ] }, "terminationParty": { "type": "string", "enum": [ "caller", "platform", "not_reported" ] }, "callerEndedAfterFallback": { "type": "boolean" }, "callbackOutcome": { "type": [ "string", "null" ] }, "callbackDecision": { "type": [ "string", "null" ] }, "callbackReason": { "type": [ "string", "null" ] }, "announcementCompleted": { "type": "boolean" }, "deliveryStage": { "type": [ "string", "null" ] }, "trackingVersion": { "type": "number" }, "availableAgents": { "type": [ "number", "null" ] }, "id": { "type": "string" }, "callerLabel": { "type": "string" }, "createdAt": { "type": "string" }, "destination": { "type": "string" }, "disposition": { "type": "string" }, "attemptsForCaller": { "type": "number" }, "reconnectCallId": { "type": [ "string", "null" ] }, "reconnectedAt": { "type": [ "string", "null" ] }, "reconnectDirection": { "type": [ "string", "null" ] }, "reconnectDisposition": { "type": [ "string", "null" ] }, "recovery": { "type": "string", "enum": [ "connected", "observing", "no_connection_within_24h", "anonymous" ] } }, "required": [ "outcome", "agentConnectedAt", "queuedAt", "fallbackReason", "fallbackAction", "terminationParty", "callerEndedAfterFallback", "callbackOutcome", "callbackDecision", "callbackReason", "announcementCompleted", "deliveryStage", "trackingVersion", "availableAgents", "id", "callerLabel", "createdAt", "destination", "disposition", "attemptsForCaller", "reconnectCallId", "reconnectedAt", "reconnectDirection", "reconnectDisposition", "recovery" ], "additionalProperties": false } } }, "required": [ "asOf", "timezone", "observationHours", "summary", "callbackDecisions", "callbackPolicies", "itemsTotal", "page", "perPage", "view", "items" ], "additionalProperties": false }, "GetV2CallsMetricsAccessNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAccessNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAccessNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAccessNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsMetricsAccessNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAccessNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAccessNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAccessNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAccessNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAccessNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsParameterSearch": { "description": "Search query: matches customer name, phone number, or disposition", "type": "string" }, "GetV2CallsMetricsAnalyticsOperationsParameterCustomerId": { "description": "Filter calls by customer ID for exact customer call history", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsMetricsAnalyticsOperationsParameterCampaignIds": { "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "type": "string" }, "GetV2CallsMetricsAnalyticsOperationsParameterAgentUserIds": { "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "type": "string" }, "GetV2CallsMetricsAnalyticsOperationsParameterDurationOperator": { "description": "Duration filter operator (less than or equal, greater than or equal)", "type": "string", "enum": [ "<=", ">=" ] }, "GetV2CallsMetricsAnalyticsOperationsParameterDurationValue": { "description": "Duration value in seconds to filter by", "type": "number", "minimum": 0 }, "GetV2CallsMetricsAnalyticsOperationsParameterDirection": { "description": "Filter by call direction", "type": "string", "enum": [ "inbound", "outbound" ] }, "GetV2CallsMetricsAnalyticsOperationsParameterCallType": { "description": "Filter by call type: Voice AI or Softphone", "type": "string", "enum": [ "voice_ai", "softphone" ] }, "GetV2CallsMetricsAnalyticsOperationsParameterStartDate": { "description": "Start date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsAnalyticsOperationsParameterEndDate": { "description": "End date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsAnalyticsOperationsParameterExcludeDispositions": { "description": "Array of disposition names to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsAnalyticsOperationsParameterIncludeDispositions": { "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "type": "string" }, "GetV2CallsMetricsAnalyticsOperationsParameterExcludeSources": { "description": "Array of source ids to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsAnalyticsOperationsParameterIncludeTestCalls": { "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsAnalyticsOperationsParameterConnectedCallsOnly": { "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsAnalyticsOperationsParameterIncludeErrorDispositions": { "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsAnalyticsOperationsParameterIntervalMinutes": { "default": 30, "type": "number" }, "GetV2CallsMetricsAnalyticsOperationsPositiveResponse": { "type": "object", "properties": { "timezone": { "type": "string" }, "asOf": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "startDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "endDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "direction": { "type": "string", "enum": [ "all", "inbound", "outbound" ] }, "handler": { "type": "string", "enum": [ "all", "softphone", "voice_ai" ] }, "intervalMinutes": { "anyOf": [ { "type": "number", "const": 30 }, { "type": "number", "const": 60 } ] }, "slaThresholdSeconds": { "type": "number" }, "summary": { "type": "object", "properties": { "totalCalls": { "type": "number" }, "inbound": { "type": "number" }, "outbound": { "type": "number" }, "offered": { "type": "number" }, "answered": { "type": "number" }, "abandoned": { "type": "number" }, "preQueueAbandoned": { "type": "number" }, "preQueueUnknown": { "type": "number" }, "otherInbound": { "type": "number" }, "aiInbound": { "default": 0, "type": "number" }, "aiOtherInbound": { "default": 0, "type": "number" }, "aiToAgent": { "default": 0, "type": "number" }, "aiHandoffs": { "default": 0, "type": "number" }, "aiHandoffsAnswered": { "default": 0, "type": "number" }, "answeredWithinSla": { "type": "number" }, "answerWaitSamples": { "type": "number" }, "totalAnswerWaitMs": { "type": "number" }, "handled": { "type": "number" }, "talkSamples": { "type": "number" }, "totalTalkMs": { "type": "number" }, "handleSamples": { "type": "number" }, "totalHandleMs": { "type": "number" }, "dncDetected": { "type": "number" }, "callbackAccepted": { "type": "number" }, "timedOut": { "type": "number" }, "fallback": { "type": "number" }, "unavailableMessage": { "default": 0, "type": "number" }, "fallbackTransfer": { "default": 0, "type": "number" }, "technicalFailure": { "type": "number" }, "waiting": { "type": "number" }, "unknown": { "type": "number" }, "transferred": { "type": "number" }, "multiAgent": { "type": "number" }, "noHoldRecorded": { "default": 0, "type": "number" }, "holdRecorded": { "default": 0, "type": "number" }, "holdTimingIncomplete": { "default": 0, "type": "number" }, "legacyTiming": { "description": "Deprecated: known incomplete hold timing on handled human calls; absence of hold evidence is treated as zero hold time.", "type": "number" }, "notConnected": { "type": "number" }, "notConnectedRate": { "type": [ "number", "null" ] }, "answerRate": { "type": [ "number", "null" ] }, "abandonRate": { "type": [ "number", "null" ] }, "serviceLevel": { "type": [ "number", "null" ] }, "averageSpeedOfAnswerMs": { "type": [ "number", "null" ] }, "averageTalkMs": { "type": [ "number", "null" ] }, "averageHandleMs": { "type": [ "number", "null" ] } }, "required": [ "totalCalls", "inbound", "outbound", "offered", "answered", "abandoned", "preQueueAbandoned", "preQueueUnknown", "otherInbound", "aiInbound", "aiOtherInbound", "aiToAgent", "aiHandoffs", "aiHandoffsAnswered", "answeredWithinSla", "answerWaitSamples", "totalAnswerWaitMs", "handled", "talkSamples", "totalTalkMs", "handleSamples", "totalHandleMs", "dncDetected", "callbackAccepted", "timedOut", "fallback", "unavailableMessage", "fallbackTransfer", "technicalFailure", "waiting", "unknown", "transferred", "multiAgent", "noHoldRecorded", "holdRecorded", "holdTimingIncomplete", "legacyTiming", "notConnected", "notConnectedRate", "answerRate", "abandonRate", "serviceLevel", "averageSpeedOfAnswerMs", "averageTalkMs", "averageHandleMs" ], "additionalProperties": false }, "intervals": { "type": "array", "items": { "type": "object", "properties": { "totalCalls": { "type": "number" }, "inbound": { "type": "number" }, "outbound": { "type": "number" }, "offered": { "type": "number" }, "answered": { "type": "number" }, "abandoned": { "type": "number" }, "preQueueAbandoned": { "type": "number" }, "preQueueUnknown": { "type": "number" }, "otherInbound": { "type": "number" }, "aiInbound": { "default": 0, "type": "number" }, "aiOtherInbound": { "default": 0, "type": "number" }, "aiToAgent": { "default": 0, "type": "number" }, "aiHandoffs": { "default": 0, "type": "number" }, "aiHandoffsAnswered": { "default": 0, "type": "number" }, "answeredWithinSla": { "type": "number" }, "answerWaitSamples": { "type": "number" }, "totalAnswerWaitMs": { "type": "number" }, "handled": { "type": "number" }, "talkSamples": { "type": "number" }, "totalTalkMs": { "type": "number" }, "handleSamples": { "type": "number" }, "totalHandleMs": { "type": "number" }, "dncDetected": { "type": "number" }, "callbackAccepted": { "type": "number" }, "timedOut": { "type": "number" }, "fallback": { "type": "number" }, "unavailableMessage": { "default": 0, "type": "number" }, "fallbackTransfer": { "default": 0, "type": "number" }, "technicalFailure": { "type": "number" }, "waiting": { "type": "number" }, "unknown": { "type": "number" }, "transferred": { "type": "number" }, "multiAgent": { "type": "number" }, "noHoldRecorded": { "default": 0, "type": "number" }, "holdRecorded": { "default": 0, "type": "number" }, "holdTimingIncomplete": { "default": 0, "type": "number" }, "legacyTiming": { "description": "Deprecated: known incomplete hold timing on handled human calls; absence of hold evidence is treated as zero hold time.", "type": "number" }, "notConnected": { "type": "number" }, "notConnectedRate": { "type": [ "number", "null" ] }, "answerRate": { "type": [ "number", "null" ] }, "abandonRate": { "type": [ "number", "null" ] }, "serviceLevel": { "type": [ "number", "null" ] }, "averageSpeedOfAnswerMs": { "type": [ "number", "null" ] }, "averageTalkMs": { "type": [ "number", "null" ] }, "averageHandleMs": { "type": [ "number", "null" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "startMinute": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "complete", "in_progress", "upcoming" ] } }, "required": [ "totalCalls", "inbound", "outbound", "offered", "answered", "abandoned", "preQueueAbandoned", "preQueueUnknown", "otherInbound", "aiInbound", "aiOtherInbound", "aiToAgent", "aiHandoffs", "aiHandoffsAnswered", "answeredWithinSla", "answerWaitSamples", "totalAnswerWaitMs", "handled", "talkSamples", "totalTalkMs", "handleSamples", "totalHandleMs", "dncDetected", "callbackAccepted", "timedOut", "fallback", "unavailableMessage", "fallbackTransfer", "technicalFailure", "waiting", "unknown", "transferred", "multiAgent", "noHoldRecorded", "holdRecorded", "holdTimingIncomplete", "legacyTiming", "notConnected", "notConnectedRate", "answerRate", "abandonRate", "serviceLevel", "averageSpeedOfAnswerMs", "averageTalkMs", "averageHandleMs", "key", "label", "startMinute", "state" ], "additionalProperties": false } }, "days": { "type": "array", "items": { "type": "object", "properties": { "totalCalls": { "type": "number" }, "inbound": { "type": "number" }, "outbound": { "type": "number" }, "offered": { "type": "number" }, "answered": { "type": "number" }, "abandoned": { "type": "number" }, "preQueueAbandoned": { "type": "number" }, "preQueueUnknown": { "type": "number" }, "otherInbound": { "type": "number" }, "aiInbound": { "default": 0, "type": "number" }, "aiOtherInbound": { "default": 0, "type": "number" }, "aiToAgent": { "default": 0, "type": "number" }, "aiHandoffs": { "default": 0, "type": "number" }, "aiHandoffsAnswered": { "default": 0, "type": "number" }, "answeredWithinSla": { "type": "number" }, "answerWaitSamples": { "type": "number" }, "totalAnswerWaitMs": { "type": "number" }, "handled": { "type": "number" }, "talkSamples": { "type": "number" }, "totalTalkMs": { "type": "number" }, "handleSamples": { "type": "number" }, "totalHandleMs": { "type": "number" }, "dncDetected": { "type": "number" }, "callbackAccepted": { "type": "number" }, "timedOut": { "type": "number" }, "fallback": { "type": "number" }, "unavailableMessage": { "default": 0, "type": "number" }, "fallbackTransfer": { "default": 0, "type": "number" }, "technicalFailure": { "type": "number" }, "waiting": { "type": "number" }, "unknown": { "type": "number" }, "transferred": { "type": "number" }, "multiAgent": { "type": "number" }, "noHoldRecorded": { "default": 0, "type": "number" }, "holdRecorded": { "default": 0, "type": "number" }, "holdTimingIncomplete": { "default": 0, "type": "number" }, "legacyTiming": { "description": "Deprecated: known incomplete hold timing on handled human calls; absence of hold evidence is treated as zero hold time.", "type": "number" }, "notConnected": { "type": "number" }, "notConnectedRate": { "type": [ "number", "null" ] }, "answerRate": { "type": [ "number", "null" ] }, "abandonRate": { "type": [ "number", "null" ] }, "serviceLevel": { "type": [ "number", "null" ] }, "averageSpeedOfAnswerMs": { "type": [ "number", "null" ] }, "averageTalkMs": { "type": [ "number", "null" ] }, "averageHandleMs": { "type": [ "number", "null" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "startMinute": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "complete", "in_progress", "upcoming" ] } }, "required": [ "totalCalls", "inbound", "outbound", "offered", "answered", "abandoned", "preQueueAbandoned", "preQueueUnknown", "otherInbound", "aiInbound", "aiOtherInbound", "aiToAgent", "aiHandoffs", "aiHandoffsAnswered", "answeredWithinSla", "answerWaitSamples", "totalAnswerWaitMs", "handled", "talkSamples", "totalTalkMs", "handleSamples", "totalHandleMs", "dncDetected", "callbackAccepted", "timedOut", "fallback", "unavailableMessage", "fallbackTransfer", "technicalFailure", "waiting", "unknown", "transferred", "multiAgent", "noHoldRecorded", "holdRecorded", "holdTimingIncomplete", "legacyTiming", "notConnected", "notConnectedRate", "answerRate", "abandonRate", "serviceLevel", "averageSpeedOfAnswerMs", "averageTalkMs", "averageHandleMs", "key", "label", "startMinute", "state" ], "additionalProperties": false } }, "emptyDaysOmitted": { "type": "boolean" }, "busiest": { "type": "array", "items": { "type": "object", "properties": { "totalCalls": { "type": "number" }, "inbound": { "type": "number" }, "outbound": { "type": "number" }, "offered": { "type": "number" }, "answered": { "type": "number" }, "abandoned": { "type": "number" }, "preQueueAbandoned": { "type": "number" }, "preQueueUnknown": { "type": "number" }, "otherInbound": { "type": "number" }, "aiInbound": { "default": 0, "type": "number" }, "aiOtherInbound": { "default": 0, "type": "number" }, "aiToAgent": { "default": 0, "type": "number" }, "aiHandoffs": { "default": 0, "type": "number" }, "aiHandoffsAnswered": { "default": 0, "type": "number" }, "answeredWithinSla": { "type": "number" }, "answerWaitSamples": { "type": "number" }, "totalAnswerWaitMs": { "type": "number" }, "handled": { "type": "number" }, "talkSamples": { "type": "number" }, "totalTalkMs": { "type": "number" }, "handleSamples": { "type": "number" }, "totalHandleMs": { "type": "number" }, "dncDetected": { "type": "number" }, "callbackAccepted": { "type": "number" }, "timedOut": { "type": "number" }, "fallback": { "type": "number" }, "unavailableMessage": { "default": 0, "type": "number" }, "fallbackTransfer": { "default": 0, "type": "number" }, "technicalFailure": { "type": "number" }, "waiting": { "type": "number" }, "unknown": { "type": "number" }, "transferred": { "type": "number" }, "multiAgent": { "type": "number" }, "noHoldRecorded": { "default": 0, "type": "number" }, "holdRecorded": { "default": 0, "type": "number" }, "holdTimingIncomplete": { "default": 0, "type": "number" }, "legacyTiming": { "description": "Deprecated: known incomplete hold timing on handled human calls; absence of hold evidence is treated as zero hold time.", "type": "number" }, "notConnected": { "type": "number" }, "notConnectedRate": { "type": [ "number", "null" ] }, "answerRate": { "type": [ "number", "null" ] }, "abandonRate": { "type": [ "number", "null" ] }, "serviceLevel": { "type": [ "number", "null" ] }, "averageSpeedOfAnswerMs": { "type": [ "number", "null" ] }, "averageTalkMs": { "type": [ "number", "null" ] }, "averageHandleMs": { "type": [ "number", "null" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "startMinute": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "complete", "in_progress", "upcoming" ] } }, "required": [ "totalCalls", "inbound", "outbound", "offered", "answered", "abandoned", "preQueueAbandoned", "preQueueUnknown", "otherInbound", "aiInbound", "aiOtherInbound", "aiToAgent", "aiHandoffs", "aiHandoffsAnswered", "answeredWithinSla", "answerWaitSamples", "totalAnswerWaitMs", "handled", "talkSamples", "totalTalkMs", "handleSamples", "totalHandleMs", "dncDetected", "callbackAccepted", "timedOut", "fallback", "unavailableMessage", "fallbackTransfer", "technicalFailure", "waiting", "unknown", "transferred", "multiAgent", "noHoldRecorded", "holdRecorded", "holdTimingIncomplete", "legacyTiming", "notConnected", "notConnectedRate", "answerRate", "abandonRate", "serviceLevel", "averageSpeedOfAnswerMs", "averageTalkMs", "averageHandleMs", "key", "label", "startMinute", "state" ], "additionalProperties": false } }, "dispositions": { "type": "array", "items": { "type": "object", "properties": { "disposition": { "type": "string" }, "count": { "type": "number" }, "share": { "type": "number" } }, "required": [ "disposition", "count", "share" ], "additionalProperties": false } }, "durationCoverage": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "direction": { "type": "string" }, "calls": { "type": "number" }, "handled": { "type": "number" }, "talkSamples": { "type": "number" }, "handleSamples": { "type": "number" } }, "required": [ "kind", "direction", "calls", "handled", "talkSamples", "handleSamples" ], "additionalProperties": false } }, "availableFilters": { "type": "object", "properties": { "campaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "destinations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "campaigns", "destinations" ], "additionalProperties": false } }, "required": [ "timezone", "asOf", "startDate", "endDate", "direction", "handler", "intervalMinutes", "slaThresholdSeconds", "summary", "intervals", "days", "busiest", "dispositions", "durationCoverage", "availableFilters" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsAnalyticsOperationsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsParameterStartDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } ] }, "GetV2CallsMetricsOperationsParameterEndDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } ] }, "GetV2CallsMetricsOperationsParameterDirection": { "default": "all", "type": "string", "enum": [ "all", "inbound", "outbound" ] }, "GetV2CallsMetricsOperationsParameterHandler": { "default": "all", "type": "string", "enum": [ "all", "softphone", "voice_ai" ] }, "GetV2CallsMetricsOperationsParameterIntervalMinutes": { "default": 30, "type": "number" }, "GetV2CallsMetricsOperationsParameterCampaignIds": { "type": "string" }, "GetV2CallsMetricsOperationsParameterTransferConfigIds": { "type": "string" }, "GetV2CallsMetricsOperationsPositiveResponse": { "type": "object", "properties": { "timezone": { "type": "string" }, "asOf": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "startDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "endDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "direction": { "type": "string", "enum": [ "all", "inbound", "outbound" ] }, "handler": { "type": "string", "enum": [ "all", "softphone", "voice_ai" ] }, "intervalMinutes": { "anyOf": [ { "type": "number", "const": 30 }, { "type": "number", "const": 60 } ] }, "slaThresholdSeconds": { "type": "number" }, "summary": { "type": "object", "properties": { "totalCalls": { "type": "number" }, "inbound": { "type": "number" }, "outbound": { "type": "number" }, "offered": { "type": "number" }, "answered": { "type": "number" }, "abandoned": { "type": "number" }, "preQueueAbandoned": { "type": "number" }, "preQueueUnknown": { "type": "number" }, "otherInbound": { "type": "number" }, "aiInbound": { "default": 0, "type": "number" }, "aiOtherInbound": { "default": 0, "type": "number" }, "aiToAgent": { "default": 0, "type": "number" }, "aiHandoffs": { "default": 0, "type": "number" }, "aiHandoffsAnswered": { "default": 0, "type": "number" }, "answeredWithinSla": { "type": "number" }, "answerWaitSamples": { "type": "number" }, "totalAnswerWaitMs": { "type": "number" }, "handled": { "type": "number" }, "talkSamples": { "type": "number" }, "totalTalkMs": { "type": "number" }, "handleSamples": { "type": "number" }, "totalHandleMs": { "type": "number" }, "dncDetected": { "type": "number" }, "callbackAccepted": { "type": "number" }, "timedOut": { "type": "number" }, "fallback": { "type": "number" }, "unavailableMessage": { "default": 0, "type": "number" }, "fallbackTransfer": { "default": 0, "type": "number" }, "technicalFailure": { "type": "number" }, "waiting": { "type": "number" }, "unknown": { "type": "number" }, "transferred": { "type": "number" }, "multiAgent": { "type": "number" }, "noHoldRecorded": { "default": 0, "type": "number" }, "holdRecorded": { "default": 0, "type": "number" }, "holdTimingIncomplete": { "default": 0, "type": "number" }, "legacyTiming": { "description": "Deprecated: known incomplete hold timing on handled human calls; absence of hold evidence is treated as zero hold time.", "type": "number" }, "notConnected": { "type": "number" }, "notConnectedRate": { "type": [ "number", "null" ] }, "answerRate": { "type": [ "number", "null" ] }, "abandonRate": { "type": [ "number", "null" ] }, "serviceLevel": { "type": [ "number", "null" ] }, "averageSpeedOfAnswerMs": { "type": [ "number", "null" ] }, "averageTalkMs": { "type": [ "number", "null" ] }, "averageHandleMs": { "type": [ "number", "null" ] } }, "required": [ "totalCalls", "inbound", "outbound", "offered", "answered", "abandoned", "preQueueAbandoned", "preQueueUnknown", "otherInbound", "aiInbound", "aiOtherInbound", "aiToAgent", "aiHandoffs", "aiHandoffsAnswered", "answeredWithinSla", "answerWaitSamples", "totalAnswerWaitMs", "handled", "talkSamples", "totalTalkMs", "handleSamples", "totalHandleMs", "dncDetected", "callbackAccepted", "timedOut", "fallback", "unavailableMessage", "fallbackTransfer", "technicalFailure", "waiting", "unknown", "transferred", "multiAgent", "noHoldRecorded", "holdRecorded", "holdTimingIncomplete", "legacyTiming", "notConnected", "notConnectedRate", "answerRate", "abandonRate", "serviceLevel", "averageSpeedOfAnswerMs", "averageTalkMs", "averageHandleMs" ], "additionalProperties": false }, "intervals": { "type": "array", "items": { "type": "object", "properties": { "totalCalls": { "type": "number" }, "inbound": { "type": "number" }, "outbound": { "type": "number" }, "offered": { "type": "number" }, "answered": { "type": "number" }, "abandoned": { "type": "number" }, "preQueueAbandoned": { "type": "number" }, "preQueueUnknown": { "type": "number" }, "otherInbound": { "type": "number" }, "aiInbound": { "default": 0, "type": "number" }, "aiOtherInbound": { "default": 0, "type": "number" }, "aiToAgent": { "default": 0, "type": "number" }, "aiHandoffs": { "default": 0, "type": "number" }, "aiHandoffsAnswered": { "default": 0, "type": "number" }, "answeredWithinSla": { "type": "number" }, "answerWaitSamples": { "type": "number" }, "totalAnswerWaitMs": { "type": "number" }, "handled": { "type": "number" }, "talkSamples": { "type": "number" }, "totalTalkMs": { "type": "number" }, "handleSamples": { "type": "number" }, "totalHandleMs": { "type": "number" }, "dncDetected": { "type": "number" }, "callbackAccepted": { "type": "number" }, "timedOut": { "type": "number" }, "fallback": { "type": "number" }, "unavailableMessage": { "default": 0, "type": "number" }, "fallbackTransfer": { "default": 0, "type": "number" }, "technicalFailure": { "type": "number" }, "waiting": { "type": "number" }, "unknown": { "type": "number" }, "transferred": { "type": "number" }, "multiAgent": { "type": "number" }, "noHoldRecorded": { "default": 0, "type": "number" }, "holdRecorded": { "default": 0, "type": "number" }, "holdTimingIncomplete": { "default": 0, "type": "number" }, "legacyTiming": { "description": "Deprecated: known incomplete hold timing on handled human calls; absence of hold evidence is treated as zero hold time.", "type": "number" }, "notConnected": { "type": "number" }, "notConnectedRate": { "type": [ "number", "null" ] }, "answerRate": { "type": [ "number", "null" ] }, "abandonRate": { "type": [ "number", "null" ] }, "serviceLevel": { "type": [ "number", "null" ] }, "averageSpeedOfAnswerMs": { "type": [ "number", "null" ] }, "averageTalkMs": { "type": [ "number", "null" ] }, "averageHandleMs": { "type": [ "number", "null" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "startMinute": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "complete", "in_progress", "upcoming" ] } }, "required": [ "totalCalls", "inbound", "outbound", "offered", "answered", "abandoned", "preQueueAbandoned", "preQueueUnknown", "otherInbound", "aiInbound", "aiOtherInbound", "aiToAgent", "aiHandoffs", "aiHandoffsAnswered", "answeredWithinSla", "answerWaitSamples", "totalAnswerWaitMs", "handled", "talkSamples", "totalTalkMs", "handleSamples", "totalHandleMs", "dncDetected", "callbackAccepted", "timedOut", "fallback", "unavailableMessage", "fallbackTransfer", "technicalFailure", "waiting", "unknown", "transferred", "multiAgent", "noHoldRecorded", "holdRecorded", "holdTimingIncomplete", "legacyTiming", "notConnected", "notConnectedRate", "answerRate", "abandonRate", "serviceLevel", "averageSpeedOfAnswerMs", "averageTalkMs", "averageHandleMs", "key", "label", "startMinute", "state" ], "additionalProperties": false } }, "days": { "type": "array", "items": { "type": "object", "properties": { "totalCalls": { "type": "number" }, "inbound": { "type": "number" }, "outbound": { "type": "number" }, "offered": { "type": "number" }, "answered": { "type": "number" }, "abandoned": { "type": "number" }, "preQueueAbandoned": { "type": "number" }, "preQueueUnknown": { "type": "number" }, "otherInbound": { "type": "number" }, "aiInbound": { "default": 0, "type": "number" }, "aiOtherInbound": { "default": 0, "type": "number" }, "aiToAgent": { "default": 0, "type": "number" }, "aiHandoffs": { "default": 0, "type": "number" }, "aiHandoffsAnswered": { "default": 0, "type": "number" }, "answeredWithinSla": { "type": "number" }, "answerWaitSamples": { "type": "number" }, "totalAnswerWaitMs": { "type": "number" }, "handled": { "type": "number" }, "talkSamples": { "type": "number" }, "totalTalkMs": { "type": "number" }, "handleSamples": { "type": "number" }, "totalHandleMs": { "type": "number" }, "dncDetected": { "type": "number" }, "callbackAccepted": { "type": "number" }, "timedOut": { "type": "number" }, "fallback": { "type": "number" }, "unavailableMessage": { "default": 0, "type": "number" }, "fallbackTransfer": { "default": 0, "type": "number" }, "technicalFailure": { "type": "number" }, "waiting": { "type": "number" }, "unknown": { "type": "number" }, "transferred": { "type": "number" }, "multiAgent": { "type": "number" }, "noHoldRecorded": { "default": 0, "type": "number" }, "holdRecorded": { "default": 0, "type": "number" }, "holdTimingIncomplete": { "default": 0, "type": "number" }, "legacyTiming": { "description": "Deprecated: known incomplete hold timing on handled human calls; absence of hold evidence is treated as zero hold time.", "type": "number" }, "notConnected": { "type": "number" }, "notConnectedRate": { "type": [ "number", "null" ] }, "answerRate": { "type": [ "number", "null" ] }, "abandonRate": { "type": [ "number", "null" ] }, "serviceLevel": { "type": [ "number", "null" ] }, "averageSpeedOfAnswerMs": { "type": [ "number", "null" ] }, "averageTalkMs": { "type": [ "number", "null" ] }, "averageHandleMs": { "type": [ "number", "null" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "startMinute": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "complete", "in_progress", "upcoming" ] } }, "required": [ "totalCalls", "inbound", "outbound", "offered", "answered", "abandoned", "preQueueAbandoned", "preQueueUnknown", "otherInbound", "aiInbound", "aiOtherInbound", "aiToAgent", "aiHandoffs", "aiHandoffsAnswered", "answeredWithinSla", "answerWaitSamples", "totalAnswerWaitMs", "handled", "talkSamples", "totalTalkMs", "handleSamples", "totalHandleMs", "dncDetected", "callbackAccepted", "timedOut", "fallback", "unavailableMessage", "fallbackTransfer", "technicalFailure", "waiting", "unknown", "transferred", "multiAgent", "noHoldRecorded", "holdRecorded", "holdTimingIncomplete", "legacyTiming", "notConnected", "notConnectedRate", "answerRate", "abandonRate", "serviceLevel", "averageSpeedOfAnswerMs", "averageTalkMs", "averageHandleMs", "key", "label", "startMinute", "state" ], "additionalProperties": false } }, "emptyDaysOmitted": { "type": "boolean" }, "busiest": { "type": "array", "items": { "type": "object", "properties": { "totalCalls": { "type": "number" }, "inbound": { "type": "number" }, "outbound": { "type": "number" }, "offered": { "type": "number" }, "answered": { "type": "number" }, "abandoned": { "type": "number" }, "preQueueAbandoned": { "type": "number" }, "preQueueUnknown": { "type": "number" }, "otherInbound": { "type": "number" }, "aiInbound": { "default": 0, "type": "number" }, "aiOtherInbound": { "default": 0, "type": "number" }, "aiToAgent": { "default": 0, "type": "number" }, "aiHandoffs": { "default": 0, "type": "number" }, "aiHandoffsAnswered": { "default": 0, "type": "number" }, "answeredWithinSla": { "type": "number" }, "answerWaitSamples": { "type": "number" }, "totalAnswerWaitMs": { "type": "number" }, "handled": { "type": "number" }, "talkSamples": { "type": "number" }, "totalTalkMs": { "type": "number" }, "handleSamples": { "type": "number" }, "totalHandleMs": { "type": "number" }, "dncDetected": { "type": "number" }, "callbackAccepted": { "type": "number" }, "timedOut": { "type": "number" }, "fallback": { "type": "number" }, "unavailableMessage": { "default": 0, "type": "number" }, "fallbackTransfer": { "default": 0, "type": "number" }, "technicalFailure": { "type": "number" }, "waiting": { "type": "number" }, "unknown": { "type": "number" }, "transferred": { "type": "number" }, "multiAgent": { "type": "number" }, "noHoldRecorded": { "default": 0, "type": "number" }, "holdRecorded": { "default": 0, "type": "number" }, "holdTimingIncomplete": { "default": 0, "type": "number" }, "legacyTiming": { "description": "Deprecated: known incomplete hold timing on handled human calls; absence of hold evidence is treated as zero hold time.", "type": "number" }, "notConnected": { "type": "number" }, "notConnectedRate": { "type": [ "number", "null" ] }, "answerRate": { "type": [ "number", "null" ] }, "abandonRate": { "type": [ "number", "null" ] }, "serviceLevel": { "type": [ "number", "null" ] }, "averageSpeedOfAnswerMs": { "type": [ "number", "null" ] }, "averageTalkMs": { "type": [ "number", "null" ] }, "averageHandleMs": { "type": [ "number", "null" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "startMinute": { "type": [ "number", "null" ] }, "state": { "type": "string", "enum": [ "complete", "in_progress", "upcoming" ] } }, "required": [ "totalCalls", "inbound", "outbound", "offered", "answered", "abandoned", "preQueueAbandoned", "preQueueUnknown", "otherInbound", "aiInbound", "aiOtherInbound", "aiToAgent", "aiHandoffs", "aiHandoffsAnswered", "answeredWithinSla", "answerWaitSamples", "totalAnswerWaitMs", "handled", "talkSamples", "totalTalkMs", "handleSamples", "totalHandleMs", "dncDetected", "callbackAccepted", "timedOut", "fallback", "unavailableMessage", "fallbackTransfer", "technicalFailure", "waiting", "unknown", "transferred", "multiAgent", "noHoldRecorded", "holdRecorded", "holdTimingIncomplete", "legacyTiming", "notConnected", "notConnectedRate", "answerRate", "abandonRate", "serviceLevel", "averageSpeedOfAnswerMs", "averageTalkMs", "averageHandleMs", "key", "label", "startMinute", "state" ], "additionalProperties": false } }, "dispositions": { "type": "array", "items": { "type": "object", "properties": { "disposition": { "type": "string" }, "count": { "type": "number" }, "share": { "type": "number" } }, "required": [ "disposition", "count", "share" ], "additionalProperties": false } }, "durationCoverage": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "direction": { "type": "string" }, "calls": { "type": "number" }, "handled": { "type": "number" }, "talkSamples": { "type": "number" }, "handleSamples": { "type": "number" } }, "required": [ "kind", "direction", "calls", "handled", "talkSamples", "handleSamples" ], "additionalProperties": false } }, "availableFilters": { "type": "object", "properties": { "campaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "destinations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "campaigns", "destinations" ], "additionalProperties": false } }, "required": [ "timezone", "asOf", "startDate", "endDate", "direction", "handler", "intervalMinutes", "slaThresholdSeconds", "summary", "intervals", "days", "busiest", "dispositions", "durationCoverage", "availableFilters" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsOperationsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryParameterSearch": { "description": "Search query: matches customer name, phone number, or disposition", "type": "string" }, "GetV2CallsMetricsSummaryParameterCustomerId": { "description": "Filter calls by customer ID for exact customer call history", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsMetricsSummaryParameterCampaignIds": { "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "type": "string" }, "GetV2CallsMetricsSummaryParameterAgentUserIds": { "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "type": "string" }, "GetV2CallsMetricsSummaryParameterDurationOperator": { "description": "Duration filter operator (less than or equal, greater than or equal)", "type": "string", "enum": [ "<=", ">=" ] }, "GetV2CallsMetricsSummaryParameterDurationValue": { "description": "Duration value in seconds to filter by", "type": "number", "minimum": 0 }, "GetV2CallsMetricsSummaryParameterDirection": { "description": "Filter by call direction", "type": "string", "enum": [ "inbound", "outbound" ] }, "GetV2CallsMetricsSummaryParameterCallType": { "description": "Filter by call type: Voice AI or Softphone", "type": "string", "enum": [ "voice_ai", "softphone" ] }, "GetV2CallsMetricsSummaryParameterStartDate": { "description": "Start date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsSummaryParameterEndDate": { "description": "End date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsSummaryParameterExcludeDispositions": { "description": "Array of disposition names to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsSummaryParameterIncludeDispositions": { "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "type": "string" }, "GetV2CallsMetricsSummaryParameterExcludeSources": { "description": "Array of source ids to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsSummaryParameterIncludeTestCalls": { "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsSummaryParameterConnectedCallsOnly": { "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsSummaryParameterIncludeErrorDispositions": { "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsSummaryParameterCampaigns": { "type": "string" }, "GetV2CallsMetricsSummaryParameterSources": { "type": "string" }, "GetV2CallsMetricsSummaryPositiveResponse": { "type": "object", "properties": { "total": { "type": "number" }, "inbound": { "type": "number" }, "outbound": { "type": "number" }, "avgDurationSeconds": { "type": "number" }, "voicemailRate": { "type": "number" }, "outboundVoicemailCount": { "type": "number" }, "outboundVoicemailRate": { "type": [ "number", "null" ] }, "appointmentsBooked": { "type": "number" }, "dncDetectedRate": { "type": "number" } }, "required": [ "total", "inbound", "outbound", "avgDurationSeconds", "voicemailRate", "outboundVoicemailCount", "outboundVoicemailRate", "appointmentsBooked", "dncDetectedRate" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsSummaryNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesParameterSearch": { "description": "Search query: matches customer name, phone number, or disposition", "type": "string" }, "GetV2CallsMetricsVolumeTimeSeriesParameterCustomerId": { "description": "Filter calls by customer ID for exact customer call history", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsMetricsVolumeTimeSeriesParameterCampaignIds": { "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "type": "string" }, "GetV2CallsMetricsVolumeTimeSeriesParameterAgentUserIds": { "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "type": "string" }, "GetV2CallsMetricsVolumeTimeSeriesParameterDurationOperator": { "description": "Duration filter operator (less than or equal, greater than or equal)", "type": "string", "enum": [ "<=", ">=" ] }, "GetV2CallsMetricsVolumeTimeSeriesParameterDurationValue": { "description": "Duration value in seconds to filter by", "type": "number", "minimum": 0 }, "GetV2CallsMetricsVolumeTimeSeriesParameterDirection": { "description": "Filter by call direction", "type": "string", "enum": [ "inbound", "outbound" ] }, "GetV2CallsMetricsVolumeTimeSeriesParameterCallType": { "description": "Filter by call type: Voice AI or Softphone", "type": "string", "enum": [ "voice_ai", "softphone" ] }, "GetV2CallsMetricsVolumeTimeSeriesParameterStartDate": { "description": "Start date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsVolumeTimeSeriesParameterEndDate": { "description": "End date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsVolumeTimeSeriesParameterExcludeDispositions": { "description": "Array of disposition names to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsVolumeTimeSeriesParameterIncludeDispositions": { "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "type": "string" }, "GetV2CallsMetricsVolumeTimeSeriesParameterExcludeSources": { "description": "Array of source ids to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsVolumeTimeSeriesParameterIncludeTestCalls": { "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsVolumeTimeSeriesParameterConnectedCallsOnly": { "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsVolumeTimeSeriesParameterIncludeErrorDispositions": { "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsVolumeTimeSeriesParameterCampaigns": { "type": "string" }, "GetV2CallsMetricsVolumeTimeSeriesParameterSources": { "type": "string" }, "GetV2CallsMetricsVolumeTimeSeriesPositiveResponse": { "type": "object", "properties": { "granularity": { "type": "string", "enum": [ "hour", "day" ] }, "points": { "type": "array", "items": { "type": "object", "properties": { "ts": { "type": "string" }, "inbound": { "type": "number" }, "outbound": { "type": "number" }, "total": { "type": "number" } }, "required": [ "ts", "inbound", "outbound", "total" ], "additionalProperties": false } } }, "required": [ "granularity", "points" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsVolumeTimeSeriesNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionParameterSearch": { "description": "Search query: matches customer name, phone number, or disposition", "type": "string" }, "GetV2CallsMetricsByDispositionParameterCustomerId": { "description": "Filter calls by customer ID for exact customer call history", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsMetricsByDispositionParameterCampaignIds": { "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "type": "string" }, "GetV2CallsMetricsByDispositionParameterAgentUserIds": { "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "type": "string" }, "GetV2CallsMetricsByDispositionParameterDurationOperator": { "description": "Duration filter operator (less than or equal, greater than or equal)", "type": "string", "enum": [ "<=", ">=" ] }, "GetV2CallsMetricsByDispositionParameterDurationValue": { "description": "Duration value in seconds to filter by", "type": "number", "minimum": 0 }, "GetV2CallsMetricsByDispositionParameterDirection": { "description": "Filter by call direction", "type": "string", "enum": [ "inbound", "outbound" ] }, "GetV2CallsMetricsByDispositionParameterCallType": { "description": "Filter by call type: Voice AI or Softphone", "type": "string", "enum": [ "voice_ai", "softphone" ] }, "GetV2CallsMetricsByDispositionParameterStartDate": { "description": "Start date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsByDispositionParameterEndDate": { "description": "End date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsByDispositionParameterExcludeDispositions": { "description": "Array of disposition names to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsByDispositionParameterIncludeDispositions": { "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "type": "string" }, "GetV2CallsMetricsByDispositionParameterExcludeSources": { "description": "Array of source ids to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsByDispositionParameterIncludeTestCalls": { "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsByDispositionParameterConnectedCallsOnly": { "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsByDispositionParameterIncludeErrorDispositions": { "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsByDispositionParameterCampaigns": { "type": "string" }, "GetV2CallsMetricsByDispositionParameterSources": { "type": "string" }, "GetV2CallsMetricsByDispositionPositiveResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "disposition": { "type": "string" }, "count": { "type": "number" } }, "required": [ "disposition", "count" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByDispositionNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignParameterSearch": { "description": "Search query: matches customer name, phone number, or disposition", "type": "string" }, "GetV2CallsMetricsByCampaignParameterCustomerId": { "description": "Filter calls by customer ID for exact customer call history", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsMetricsByCampaignParameterCampaignIds": { "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "type": "string" }, "GetV2CallsMetricsByCampaignParameterAgentUserIds": { "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "type": "string" }, "GetV2CallsMetricsByCampaignParameterDurationOperator": { "description": "Duration filter operator (less than or equal, greater than or equal)", "type": "string", "enum": [ "<=", ">=" ] }, "GetV2CallsMetricsByCampaignParameterDurationValue": { "description": "Duration value in seconds to filter by", "type": "number", "minimum": 0 }, "GetV2CallsMetricsByCampaignParameterDirection": { "description": "Filter by call direction", "type": "string", "enum": [ "inbound", "outbound" ] }, "GetV2CallsMetricsByCampaignParameterCallType": { "description": "Filter by call type: Voice AI or Softphone", "type": "string", "enum": [ "voice_ai", "softphone" ] }, "GetV2CallsMetricsByCampaignParameterStartDate": { "description": "Start date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsByCampaignParameterEndDate": { "description": "End date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsByCampaignParameterExcludeDispositions": { "description": "Array of disposition names to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsByCampaignParameterIncludeDispositions": { "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "type": "string" }, "GetV2CallsMetricsByCampaignParameterExcludeSources": { "description": "Array of source ids to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsByCampaignParameterIncludeTestCalls": { "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsByCampaignParameterConnectedCallsOnly": { "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsByCampaignParameterIncludeErrorDispositions": { "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsByCampaignParameterCampaigns": { "type": "string" }, "GetV2CallsMetricsByCampaignParameterSources": { "type": "string" }, "GetV2CallsMetricsByCampaignPositiveResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "campaignId": { "type": [ "string", "null" ] }, "campaignName": { "type": "string" }, "count": { "type": "number" }, "avgDurationSeconds": { "type": "number" } }, "required": [ "campaignId", "campaignName", "count", "avgDurationSeconds" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsByCampaignNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsParameterSearch": { "description": "Search query: matches customer name, phone number, or disposition", "type": "string" }, "GetV2CallsMetricsDurationBucketsParameterCustomerId": { "description": "Filter calls by customer ID for exact customer call history", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsMetricsDurationBucketsParameterCampaignIds": { "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "type": "string" }, "GetV2CallsMetricsDurationBucketsParameterAgentUserIds": { "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "type": "string" }, "GetV2CallsMetricsDurationBucketsParameterDurationOperator": { "description": "Duration filter operator (less than or equal, greater than or equal)", "type": "string", "enum": [ "<=", ">=" ] }, "GetV2CallsMetricsDurationBucketsParameterDurationValue": { "description": "Duration value in seconds to filter by", "type": "number", "minimum": 0 }, "GetV2CallsMetricsDurationBucketsParameterDirection": { "description": "Filter by call direction", "type": "string", "enum": [ "inbound", "outbound" ] }, "GetV2CallsMetricsDurationBucketsParameterCallType": { "description": "Filter by call type: Voice AI or Softphone", "type": "string", "enum": [ "voice_ai", "softphone" ] }, "GetV2CallsMetricsDurationBucketsParameterStartDate": { "description": "Start date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsDurationBucketsParameterEndDate": { "description": "End date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsMetricsDurationBucketsParameterExcludeDispositions": { "description": "Array of disposition names to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsDurationBucketsParameterIncludeDispositions": { "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "type": "string" }, "GetV2CallsMetricsDurationBucketsParameterExcludeSources": { "description": "Array of source ids to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsMetricsDurationBucketsParameterIncludeTestCalls": { "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsDurationBucketsParameterConnectedCallsOnly": { "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsDurationBucketsParameterIncludeErrorDispositions": { "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsMetricsDurationBucketsParameterCampaigns": { "type": "string" }, "GetV2CallsMetricsDurationBucketsParameterSources": { "type": "string" }, "GetV2CallsMetricsDurationBucketsPositiveResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string", "enum": [ "<30s", "30-60s", "1-3m", "3-5m", "5m+" ] }, "count": { "type": "number" } }, "required": [ "bucket", "count" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsMetricsDurationBucketsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdRecordingParameterId": { "description": "Call ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsIdRecordingParameterChannel": { "description": "Which recording channel to retrieve", "default": "mono", "type": "string", "enum": [ "mono", "stereo" ] }, "GetV2CallsIdRecordingParameterDownload": { "description": "When true, signed S3 URLs request attachment disposition", "type": "boolean" }, "GetV2CallsIdRecordingPositiveResponse": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "ready" }, "recordingUrl": { "description": "Signed URL for the call recording (valid for 5 minutes). This URL provides direct access to the recording file.", "type": "string", "format": "uri" }, "expiresAt": { "description": "ISO timestamp when the signed URL expires", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "status", "recordingUrl", "expiresAt" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "processing" }, "recordingUrl": { "type": "null" }, "expiresAt": { "type": "null" } }, "required": [ "status", "recordingUrl", "expiresAt" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "unavailable" }, "recordingUrl": { "type": "null" }, "expiresAt": { "type": "null" } }, "required": [ "status", "recordingUrl", "expiresAt" ], "additionalProperties": false } ], "discriminator": { "propertyName": "status" } }, "GetV2CallsIdRecordingNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdRecordingNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdRecordingNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdRecordingNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsIdRecordingNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdRecordingNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdRecordingNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdRecordingNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdRecordingNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdRecordingNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdParameterId": { "description": "Call ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsIdPositiveResponse": { "description": "Call", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "disposition": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": [ "string", "null" ], "maxLength": 255 }, "testFlag": { "type": [ "boolean", "null" ] }, "campaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "twilioSid": { "type": [ "string", "null" ] }, "service": { "type": [ "string", "null" ], "enum": [ "vapi", "mobius", "softphone", "campaign_test", null ] }, "campaignName": { "type": [ "string", "null" ] }, "campaignIsReceptionist": { "type": "boolean" }, "agentName": { "type": [ "string", "null" ] }, "customerId": { "type": [ "string", "null" ] }, "customerName": { "type": [ "string", "null" ] }, "customerStatus": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "createdAt": { "description": "Call creation time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "duration": { "description": "Formatted duration like '2m 30s'", "type": "string" }, "assistantType": { "type": [ "string", "null" ] }, "successEvaluation": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "transcript": { "type": [ "string", "null" ] }, "detectionFlags": { "type": [ "object", "null" ], "properties": { "appointment": { "type": [ "object", "null" ], "properties": { "detected": { "type": [ "boolean", "null" ] }, "confidence": { "type": [ "string", "null" ], "enum": [ "low", "medium", "high", null ] } }, "required": [ "detected", "confidence" ], "additionalProperties": false }, "inquiry": { "type": [ "object", "null" ], "properties": { "detected": { "type": [ "boolean", "null" ] }, "confidence": { "type": [ "string", "null" ], "enum": [ "low", "medium", "high", null ] } }, "required": [ "detected", "confidence" ], "additionalProperties": false }, "dnc": { "type": [ "object", "null" ], "properties": { "detected": { "type": [ "boolean", "null" ] }, "confidence": { "type": [ "string", "null" ], "enum": [ "low", "medium", "high", null ] } }, "required": [ "detected", "confidence" ], "additionalProperties": false } }, "required": [ "appointment", "inquiry", "dnc" ], "additionalProperties": false }, "direction": { "type": [ "string", "null" ], "enum": [ "inbound", "outbound", null ] }, "sourceName": { "type": [ "string", "null" ] }, "attemptNumber": { "type": [ "number", "null" ] }, "ourPhoneNumber": { "type": [ "string", "null" ] }, "customFields": { "description": "Custom fields from the customer associated with this call", "type": "array", "items": { "description": "Formatted custom field with definition and customer-specific value", "type": "object", "properties": { "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "value": { "description": "The actual value for this customer (type determined by fieldType). Dates are represented as ISO 8601 strings.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "fieldKey", "fieldLabel", "fieldDescription", "fieldType", "isRequired", "options", "validationRules", "value" ], "additionalProperties": false } }, "participationEvents": { "description": "Softphone participation timeline: agents joining/leaving and participants added mid-call. Empty for single-agent and voice-AI calls.", "type": "array", "items": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "call_answered", "agent_joined", "agent_left", "participant_added", "call_ended", "audio_clip_played" ] }, "timestamp": { "description": "Participation event time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "endedBy": { "type": "string", "enum": [ "customer", "agent" ] }, "userId": { "type": "string" }, "userName": { "type": "string" }, "byUserId": { "type": "string" }, "byUserName": { "type": "string" }, "phoneNumber": { "type": "string" }, "transferConfigId": { "type": "string" }, "destinationName": { "type": "string" }, "callContinued": { "type": "boolean" }, "clipLabel": { "type": "string" } }, "required": [ "event", "timestamp" ], "additionalProperties": false } }, "transcriptEntries": { "description": "Structured per-utterance transcript with speaker and timestamp. Only returned by the single-call endpoint, and only for softphone calls with a live transcript.", "type": "array", "items": { "type": "object", "properties": { "speakerName": { "type": [ "string", "null" ] }, "speakerRole": { "type": [ "string", "null" ] }, "userId": { "type": [ "string", "null" ] }, "text": { "type": "string" }, "timestamp": { "description": "Transcript entry time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "text" ], "additionalProperties": false } }, "routingResult": { "type": "object", "properties": { "outcome": { "type": "string" }, "agentConnectedAt": { "type": [ "string", "null" ] }, "queuedAt": { "type": [ "string", "null" ] }, "fallbackReason": { "type": [ "string", "null" ] }, "fallbackAction": { "type": [ "string", "null" ] }, "terminationParty": { "type": "string", "enum": [ "caller", "platform", "not_reported" ] }, "callerEndedAfterFallback": { "type": "boolean" }, "callbackOutcome": { "type": [ "string", "null" ] }, "callbackDecision": { "type": [ "string", "null" ] }, "callbackReason": { "type": [ "string", "null" ] }, "announcementCompleted": { "type": "boolean" }, "deliveryStage": { "type": [ "string", "null" ] }, "trackingVersion": { "type": "number" }, "availableAgents": { "type": [ "number", "null" ] } }, "required": [ "outcome", "agentConnectedAt", "queuedAt", "fallbackReason", "fallbackAction", "terminationParty", "callerEndedAfterFallback", "callbackOutcome", "callbackDecision", "callbackReason", "announcementCompleted", "deliveryStage", "trackingVersion", "availableAgents" ], "additionalProperties": false }, "handoff": { "description": "AI-to-rep warm handoff shared by both legs of the call: the AI leg, the rep leg it reached (if any), and how the handoff ended", "type": "object", "properties": { "aiCallId": { "type": "string" }, "aiDuration": { "type": "string" }, "repCallId": { "type": [ "string", "null" ] }, "repName": { "type": [ "string", "null" ] }, "repDuration": { "type": [ "string", "null" ] }, "outcome": { "type": "string", "enum": [ "connected", "ringing", "no_answer", "caller_hung_up", "failed" ] }, "waitSeconds": { "type": [ "number", "null" ] } }, "required": [ "aiCallId", "aiDuration", "repCallId", "repName", "repDuration", "outcome", "waitSeconds" ], "additionalProperties": false } }, "required": [ "id", "disposition", "callerId", "testFlag", "campaignId", "transferConfigId", "twilioSid", "service", "campaignName", "campaignIsReceptionist", "agentName", "customerId", "customerName", "customerStatus", "createdAt", "duration", "assistantType", "successEvaluation", "summary", "transcript", "detectionFlags", "direction", "sourceName", "attemptNumber", "ourPhoneNumber", "customFields", "participationEvents" ], "additionalProperties": false }, "GetV2CallsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsParameterPage": { "default": 1, "type": "number", "minimum": 1 }, "GetV2CallsParameterPerPage": { "default": 50, "type": "number", "minimum": 1, "maximum": 100 }, "GetV2CallsParameterSortBy": { "default": "createdAt", "type": "string", "enum": [ "createdAt", "callerId", "direction", "assistantType", "duration", "disposition", "customerName", "campaignName", "agentName", "sourceName" ] }, "GetV2CallsParameterSortDirection": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "GetV2CallsParameterSortCustomFieldKey": { "type": "string", "minLength": 1, "maxLength": 100 }, "GetV2CallsParameterCustomFieldKeys": { "type": "string" }, "GetV2CallsParameterSearch": { "description": "Search query: matches customer name, phone number, or disposition", "type": "string" }, "GetV2CallsParameterCustomerId": { "description": "Filter calls by customer ID for exact customer call history", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CallsParameterCampaignIds": { "description": "Optional array of campaign IDs to filter calls by specific campaigns (comma-separated string)", "type": "string" }, "GetV2CallsParameterAgentUserIds": { "description": "Optional array of agent user IDs to filter calls by specific softphone agents (comma-separated string)", "type": "string" }, "GetV2CallsParameterDurationOperator": { "description": "Duration filter operator (less than or equal, greater than or equal)", "type": "string", "enum": [ "<=", ">=" ] }, "GetV2CallsParameterDurationValue": { "description": "Duration value in seconds to filter by", "type": "number", "minimum": 0 }, "GetV2CallsParameterDirection": { "description": "Filter by call direction", "type": "string", "enum": [ "inbound", "outbound" ] }, "GetV2CallsParameterCallType": { "description": "Filter by call type: Voice AI or Softphone", "type": "string", "enum": [ "voice_ai", "softphone" ] }, "GetV2CallsParameterStartDate": { "description": "Start date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsParameterEndDate": { "description": "End date-time for call range filtering. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "GetV2CallsParameterExcludeDispositions": { "description": "Array of disposition names to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsParameterIncludeDispositions": { "description": "Array of disposition names to limit results to (comma-separated string). Combines with excludeDispositions when both are sent.", "type": "string" }, "GetV2CallsParameterExcludeSources": { "description": "Array of source ids to exclude from results (comma-separated string)", "type": "string" }, "GetV2CallsParameterIncludeTestCalls": { "description": "When true, test calls are included in results. Default behavior is to exclude test calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsParameterConnectedCallsOnly": { "description": "Filter for connected calls only using disposition outcome types, with a legacy name fallback. Default behavior is to include all calls.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsParameterIncludeErrorDispositions": { "description": "Deprecated compatibility parameter. Error dispositions are always excluded, regardless of this value.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsParameterIncludeTotal": { "description": "When false, skips the exact count so the page can return independently. Use GET /v2/calls/count for the total.", "type": "string", "enum": [ "true", "false" ] }, "GetV2CallsPositiveResponse": { "type": "object", "properties": { "itemsTotal": { "type": "number" }, "currentPage": { "type": "number" }, "nextPage": { "type": [ "number", "null" ] }, "prevPage": { "type": [ "number", "null" ] }, "items": { "type": "array", "items": { "description": "Call", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "disposition": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": [ "string", "null" ], "maxLength": 255 }, "testFlag": { "type": [ "boolean", "null" ] }, "campaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "transferConfigId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "twilioSid": { "type": [ "string", "null" ] }, "service": { "type": [ "string", "null" ], "enum": [ "vapi", "mobius", "softphone", "campaign_test", null ] }, "campaignName": { "type": [ "string", "null" ] }, "campaignIsReceptionist": { "type": "boolean" }, "agentName": { "type": [ "string", "null" ] }, "customerId": { "type": [ "string", "null" ] }, "customerName": { "type": [ "string", "null" ] }, "customerStatus": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "createdAt": { "description": "Call creation time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "duration": { "description": "Formatted duration like '2m 30s'", "type": "string" }, "assistantType": { "type": [ "string", "null" ] }, "successEvaluation": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "transcript": { "type": [ "string", "null" ] }, "detectionFlags": { "type": [ "object", "null" ], "properties": { "appointment": { "type": [ "object", "null" ], "properties": { "detected": { "type": [ "boolean", "null" ] }, "confidence": { "type": [ "string", "null" ], "enum": [ "low", "medium", "high", null ] } }, "required": [ "detected", "confidence" ], "additionalProperties": false }, "inquiry": { "type": [ "object", "null" ], "properties": { "detected": { "type": [ "boolean", "null" ] }, "confidence": { "type": [ "string", "null" ], "enum": [ "low", "medium", "high", null ] } }, "required": [ "detected", "confidence" ], "additionalProperties": false }, "dnc": { "type": [ "object", "null" ], "properties": { "detected": { "type": [ "boolean", "null" ] }, "confidence": { "type": [ "string", "null" ], "enum": [ "low", "medium", "high", null ] } }, "required": [ "detected", "confidence" ], "additionalProperties": false } }, "required": [ "appointment", "inquiry", "dnc" ], "additionalProperties": false }, "direction": { "type": [ "string", "null" ], "enum": [ "inbound", "outbound", null ] }, "sourceName": { "type": [ "string", "null" ] }, "attemptNumber": { "type": [ "number", "null" ] }, "ourPhoneNumber": { "type": [ "string", "null" ] }, "customFields": { "description": "Custom fields from the customer associated with this call", "type": "array", "items": { "description": "Formatted custom field with definition and customer-specific value", "type": "object", "properties": { "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "value": { "description": "The actual value for this customer (type determined by fieldType). Dates are represented as ISO 8601 strings.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "fieldKey", "fieldLabel", "fieldDescription", "fieldType", "isRequired", "options", "validationRules", "value" ], "additionalProperties": false } }, "participationEvents": { "description": "Softphone participation timeline: agents joining/leaving and participants added mid-call. Empty for single-agent and voice-AI calls.", "type": "array", "items": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "call_answered", "agent_joined", "agent_left", "participant_added", "call_ended", "audio_clip_played" ] }, "timestamp": { "description": "Participation event time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "endedBy": { "type": "string", "enum": [ "customer", "agent" ] }, "userId": { "type": "string" }, "userName": { "type": "string" }, "byUserId": { "type": "string" }, "byUserName": { "type": "string" }, "phoneNumber": { "type": "string" }, "transferConfigId": { "type": "string" }, "destinationName": { "type": "string" }, "callContinued": { "type": "boolean" }, "clipLabel": { "type": "string" } }, "required": [ "event", "timestamp" ], "additionalProperties": false } }, "transcriptEntries": { "description": "Structured per-utterance transcript with speaker and timestamp. Only returned by the single-call endpoint, and only for softphone calls with a live transcript.", "type": "array", "items": { "type": "object", "properties": { "speakerName": { "type": [ "string", "null" ] }, "speakerRole": { "type": [ "string", "null" ] }, "userId": { "type": [ "string", "null" ] }, "text": { "type": "string" }, "timestamp": { "description": "Transcript entry time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "text" ], "additionalProperties": false } }, "routingResult": { "type": "object", "properties": { "outcome": { "type": "string" }, "agentConnectedAt": { "type": [ "string", "null" ] }, "queuedAt": { "type": [ "string", "null" ] }, "fallbackReason": { "type": [ "string", "null" ] }, "fallbackAction": { "type": [ "string", "null" ] }, "terminationParty": { "type": "string", "enum": [ "caller", "platform", "not_reported" ] }, "callerEndedAfterFallback": { "type": "boolean" }, "callbackOutcome": { "type": [ "string", "null" ] }, "callbackDecision": { "type": [ "string", "null" ] }, "callbackReason": { "type": [ "string", "null" ] }, "announcementCompleted": { "type": "boolean" }, "deliveryStage": { "type": [ "string", "null" ] }, "trackingVersion": { "type": "number" }, "availableAgents": { "type": [ "number", "null" ] } }, "required": [ "outcome", "agentConnectedAt", "queuedAt", "fallbackReason", "fallbackAction", "terminationParty", "callerEndedAfterFallback", "callbackOutcome", "callbackDecision", "callbackReason", "announcementCompleted", "deliveryStage", "trackingVersion", "availableAgents" ], "additionalProperties": false }, "handoff": { "description": "AI-to-rep warm handoff shared by both legs of the call: the AI leg, the rep leg it reached (if any), and how the handoff ended", "type": "object", "properties": { "aiCallId": { "type": "string" }, "aiDuration": { "type": "string" }, "repCallId": { "type": [ "string", "null" ] }, "repName": { "type": [ "string", "null" ] }, "repDuration": { "type": [ "string", "null" ] }, "outcome": { "type": "string", "enum": [ "connected", "ringing", "no_answer", "caller_hung_up", "failed" ] }, "waitSeconds": { "type": [ "number", "null" ] } }, "required": [ "aiCallId", "aiDuration", "repCallId", "repName", "repDuration", "outcome", "waitSeconds" ], "additionalProperties": false } }, "required": [ "id", "disposition", "callerId", "testFlag", "campaignId", "transferConfigId", "twilioSid", "service", "campaignName", "campaignIsReceptionist", "agentName", "customerId", "customerName", "customerStatus", "createdAt", "duration", "assistantType", "successEvaluation", "summary", "transcript", "detectionFlags", "direction", "sourceName", "attemptNumber", "ourPhoneNumber", "customFields", "participationEvents" ], "additionalProperties": false } }, "hasNextPage": { "type": "boolean" }, "totalExact": { "type": "boolean" }, "testNumberCalls": { "description": "Count of test number calls in the response", "type": "number" }, "hasSourceTracking": { "description": "Whether any campaigns have source tracking enabled", "type": "boolean" } }, "required": [ "itemsTotal", "currentPage", "nextPage", "prevPage", "items", "hasNextPage", "totalExact" ], "additionalProperties": false }, "GetV2CallsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CallsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CallsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersAgentNamesPositiveResponse": { "type": "object", "properties": { "agentNames": { "description": "List of unique agent names", "type": "array", "items": { "type": "string" } } }, "required": [ "agentNames" ], "additionalProperties": false }, "GetV2CustomersAgentNamesNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersAgentNamesNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersAgentNamesNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersAgentNamesNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CustomersAgentNamesNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersAgentNamesNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersAgentNamesNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersAgentNamesNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersAgentNamesNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersAgentNamesNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesParameterStartDate": { "description": "Carrier range start date. Format: YYYY-MM-DD", "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?)?Z?$", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "GetV2CustomersCarrierNamesParameterEndDate": { "description": "Carrier range end date. Format: YYYY-MM-DD", "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?)?Z?$", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "GetV2CustomersCarrierNamesPositiveResponse": { "type": "object", "properties": { "carrierNames": { "description": "List of distinct carrier names from customers in the date range", "type": "array", "items": { "type": "string" } } }, "required": [ "carrierNames" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersCarrierNamesNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersTagsPositiveResponse": { "type": "object", "properties": { "tags": { "description": "The organization's customer tags, sorted by name", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "color": { "description": "Color picked for the tag (red, orange, yellow, green, teal, blue, purple, pink, or gray). Null means automatic.", "type": [ "string", "null" ] }, "createdAt": { "description": "When the tag was created", "type": "string" }, "customerCount": { "description": "Number of non-deleted customers carrying this tag", "type": "number" } }, "required": [ "id", "name", "createdAt", "customerCount" ], "additionalProperties": false } } }, "required": [ "tags" ], "additionalProperties": false }, "GetV2CustomersTagsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersTagsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersTagsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersTagsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CustomersTagsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersTagsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersTagsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersTagsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersTagsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersTagsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdParameterPrescriptionId": { "description": "Prescription ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdPositiveResponse": { "type": "object", "properties": { "success": { "description": "Whether the deletion was successful", "type": "boolean" }, "message": { "description": "Success message", "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdPrescriptionsPrescriptionIdParameterPrescriptionId": { "description": "Prescription ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdPrescriptionsPrescriptionIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Prescription creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Prescription last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "dosage": { "type": [ "string", "null" ], "maxLength": 100 }, "frequency": { "type": [ "string", "null" ], "maxLength": 100 }, "route": { "type": [ "string", "null" ], "enum": [ "Oral", "Topical", "Injection", "Inhalation", "Sublingual", "Rectal", "Intravenous", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Expired", "Discontinued", null ] }, "connectureDrugId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureDosageId": { "type": [ "string", "null" ], "maxLength": 64 }, "connecturePackageId": { "type": [ "string", "null" ], "maxLength": 32 }, "ndc": { "type": [ "string", "null" ], "maxLength": 11 }, "dosageName": { "type": [ "string", "null" ], "maxLength": 255 }, "drugTypeId": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "userQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "metricQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "daysSupply": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "packageDescription": { "type": [ "string", "null" ], "maxLength": 255 }, "packageSize": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "packageQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "name", "dosage", "frequency", "route", "status", "connectureDrugId", "connectureDosageId", "connecturePackageId", "ndc", "dosageName", "drugTypeId", "userQuantity", "metricQuantity", "daysSupply", "packageDescription", "packageSize", "packageQuantity" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPrescriptionsPrescriptionIdRequestBody": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "dosage": { "type": [ "string", "null" ], "maxLength": 100 }, "frequency": { "type": [ "string", "null" ], "maxLength": 100 }, "route": { "type": [ "string", "null" ], "enum": [ "Oral", "Topical", "Injection", "Inhalation", "Sublingual", "Rectal", "Intravenous", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Expired", "Discontinued", null ] }, "connectureDrugId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureDosageId": { "type": [ "string", "null" ], "maxLength": 64 }, "connecturePackageId": { "type": [ "string", "null" ], "maxLength": 32 }, "ndc": { "type": [ "string", "null" ], "maxLength": 11 }, "dosageName": { "type": [ "string", "null" ], "maxLength": 255 }, "drugTypeId": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "userQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "metricQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "daysSupply": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "packageDescription": { "type": [ "string", "null" ], "maxLength": 255 }, "packageSize": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "packageQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 } }, "required": [] }, "PostV2CustomersIdPrescriptionsParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CustomersIdPrescriptionsPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Prescription creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Prescription last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "dosage": { "type": [ "string", "null" ], "maxLength": 100 }, "frequency": { "type": [ "string", "null" ], "maxLength": 100 }, "route": { "type": [ "string", "null" ], "enum": [ "Oral", "Topical", "Injection", "Inhalation", "Sublingual", "Rectal", "Intravenous", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Expired", "Discontinued", null ] }, "connectureDrugId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureDosageId": { "type": [ "string", "null" ], "maxLength": 64 }, "connecturePackageId": { "type": [ "string", "null" ], "maxLength": 32 }, "ndc": { "type": [ "string", "null" ], "maxLength": 11 }, "dosageName": { "type": [ "string", "null" ], "maxLength": 255 }, "drugTypeId": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "userQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "metricQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "daysSupply": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "packageDescription": { "type": [ "string", "null" ], "maxLength": 255 }, "packageSize": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "packageQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "name", "dosage", "frequency", "route", "status", "connectureDrugId", "connectureDosageId", "connecturePackageId", "ndc", "dosageName", "drugTypeId", "userQuantity", "metricQuantity", "daysSupply", "packageDescription", "packageSize", "packageQuantity" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPrescriptionsRequestBody": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "maxLength": 255 }, "dosage": { "type": [ "string", "null" ], "maxLength": 100 }, "frequency": { "type": [ "string", "null" ], "maxLength": 100 }, "route": { "type": [ "string", "null" ], "enum": [ "Oral", "Topical", "Injection", "Inhalation", "Sublingual", "Rectal", "Intravenous", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Expired", "Discontinued", null ] }, "connectureDrugId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureDosageId": { "type": [ "string", "null" ], "maxLength": 64 }, "connecturePackageId": { "type": [ "string", "null" ], "maxLength": 32 }, "ndc": { "type": [ "string", "null" ], "maxLength": 11 }, "dosageName": { "type": [ "string", "null" ], "maxLength": 255 }, "drugTypeId": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "userQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "metricQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "daysSupply": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "packageDescription": { "type": [ "string", "null" ], "maxLength": 255 }, "packageSize": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "packageQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 } }, "required": [] }, "DeleteV2CustomersIdProvidersProviderIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdProvidersProviderIdParameterProviderId": { "description": "Provider ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdProvidersProviderIdPositiveResponse": { "type": "object", "properties": { "success": { "description": "Whether the deletion was successful", "type": "boolean" }, "message": { "description": "Success message", "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false }, "DeleteV2CustomersIdProvidersProviderIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdProvidersProviderIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdProvidersProviderIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdProvidersProviderIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CustomersIdProvidersProviderIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdProvidersProviderIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdProvidersProviderIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdProvidersProviderIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdProvidersProviderIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdProvidersProviderIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdProvidersProviderIdParameterProviderId": { "description": "Provider ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdProvidersProviderIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Provider creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Provider last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "providerType": { "type": "string", "enum": [ "Primary Care", "Specialist", "Hospital", "Pharmacy" ] }, "specialty": { "type": [ "string", "null" ], "maxLength": 255 }, "providerName": { "type": [ "string", "null" ], "maxLength": 255 }, "practiceName": { "type": [ "string", "null" ], "maxLength": 255 }, "npi": { "type": [ "string", "null" ], "maxLength": 50 }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "fax": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "isPrimaryProvider": { "type": [ "boolean", "null" ] }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 }, "connectureProviderId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureAddressId": { "type": [ "string", "null" ], "maxLength": 64 }, "isIndividual": { "type": [ "boolean", "null" ] } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "providerType", "specialty", "providerName", "practiceName", "npi", "phone", "fax", "email", "address", "address2", "city", "state", "postalCode", "isPrimaryProvider", "isActive", "notes", "connectureProviderId", "connectureAddressId", "isIndividual" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdProvidersProviderIdRequestBody": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "providerType": { "type": "string", "enum": [ "Primary Care", "Specialist", "Hospital", "Pharmacy" ] }, "specialty": { "type": [ "string", "null" ], "maxLength": 255 }, "providerName": { "type": [ "string", "null" ], "maxLength": 255 }, "practiceName": { "type": [ "string", "null" ], "maxLength": 255 }, "npi": { "type": [ "string", "null" ], "maxLength": 50 }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "fax": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "isPrimaryProvider": { "type": [ "boolean", "null" ] }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 }, "connectureProviderId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureAddressId": { "type": [ "string", "null" ], "maxLength": 64 }, "isIndividual": { "type": [ "boolean", "null" ] } }, "required": [] }, "PostV2CustomersIdProvidersParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CustomersIdProvidersPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Provider creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Provider last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "providerType": { "type": "string", "enum": [ "Primary Care", "Specialist", "Hospital", "Pharmacy" ] }, "specialty": { "type": [ "string", "null" ], "maxLength": 255 }, "providerName": { "type": [ "string", "null" ], "maxLength": 255 }, "practiceName": { "type": [ "string", "null" ], "maxLength": 255 }, "npi": { "type": [ "string", "null" ], "maxLength": 50 }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "fax": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "isPrimaryProvider": { "type": [ "boolean", "null" ] }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 }, "connectureProviderId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureAddressId": { "type": [ "string", "null" ], "maxLength": 64 }, "isIndividual": { "type": [ "boolean", "null" ] } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "providerType", "specialty", "providerName", "practiceName", "npi", "phone", "fax", "email", "address", "address2", "city", "state", "postalCode", "isPrimaryProvider", "isActive", "notes", "connectureProviderId", "connectureAddressId", "isIndividual" ], "additionalProperties": false }, "PostV2CustomersIdProvidersNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdProvidersNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdProvidersNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdProvidersNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomersIdProvidersNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdProvidersNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdProvidersNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdProvidersNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdProvidersNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdProvidersNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdProvidersRequestBody": { "type": "object", "properties": { "providerType": { "type": "string", "enum": [ "Primary Care", "Specialist", "Hospital", "Pharmacy" ] }, "specialty": { "type": [ "string", "null" ], "maxLength": 255 }, "providerName": { "type": [ "string", "null" ], "maxLength": 255 }, "practiceName": { "type": [ "string", "null" ], "maxLength": 255 }, "npi": { "type": [ "string", "null" ], "maxLength": 50 }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "fax": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "isPrimaryProvider": { "type": [ "boolean", "null" ] }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 }, "connectureProviderId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureAddressId": { "type": [ "string", "null" ], "maxLength": 64 }, "isIndividual": { "type": [ "boolean", "null" ] } }, "required": [ "providerType" ] }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterPolicyId": { "description": "Policy ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterCustomFieldId": { "description": "Custom field value ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdPositiveResponse": { "type": "object", "properties": { "success": { "description": "Whether the deletion was successful", "type": "boolean" }, "message": { "description": "Success message", "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterPolicyId": { "description": "Policy ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdParameterCustomFieldId": { "description": "Custom field value ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Custom field value creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Custom field value last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "fieldDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordType": { "type": "string", "enum": [ "customers", "policies" ] }, "textValue": { "type": [ "string", "null" ] }, "numberValue": { "type": [ "string", "null" ] }, "booleanValue": { "type": [ "boolean", "null" ] }, "dateValue": { "description": "Custom field date-time value. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "selectValue": { "type": [ "string", "null" ] }, "multiSelectValue": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "id", "createdAt", "updatedAt", "fieldDefinitionId", "recordId", "recordType", "textValue", "numberValue", "booleanValue", "dateValue", "selectValue", "multiSelectValue" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdCustomFieldsCustomFieldIdRequestBody": { "type": "object", "properties": { "textValue": { "type": [ "string", "null" ] }, "numberValue": { "type": [ "string", "null" ] }, "booleanValue": { "type": [ "boolean", "null" ] }, "dateValue": { "description": "Custom field date-time value. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "selectValue": { "type": [ "string", "null" ] }, "multiSelectValue": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [] }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsParameterPolicyId": { "description": "Policy ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Custom field value creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Custom field value last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "fieldDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordType": { "type": "string", "enum": [ "customers", "policies" ] }, "textValue": { "type": [ "string", "null" ] }, "numberValue": { "type": [ "string", "null" ] }, "booleanValue": { "type": [ "boolean", "null" ] }, "dateValue": { "description": "Custom field date-time value. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "selectValue": { "type": [ "string", "null" ] }, "multiSelectValue": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "id", "createdAt", "updatedAt", "fieldDefinitionId", "recordId", "recordType", "textValue", "numberValue", "booleanValue", "dateValue", "selectValue", "multiSelectValue" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesPolicyIdCustomFieldsRequestBody": { "type": "object", "properties": { "fieldDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "textValue": { "type": [ "string", "null" ] }, "numberValue": { "type": [ "string", "null" ] }, "booleanValue": { "type": [ "boolean", "null" ] }, "dateValue": { "description": "Custom field date-time value. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "selectValue": { "type": [ "string", "null" ] }, "multiSelectValue": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "fieldDefinitionId" ] }, "DeleteV2CustomersIdPoliciesPolicyIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdPoliciesPolicyIdParameterPolicyId": { "description": "Policy ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdPoliciesPolicyIdPositiveResponse": { "type": "object", "properties": { "success": { "description": "Whether the deletion was successful", "type": "boolean" }, "message": { "description": "Success message", "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdPoliciesPolicyIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdPoliciesPolicyIdParameterPolicyId": { "description": "Policy ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdPoliciesPolicyIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Policy creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Policy last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "policyType": { "type": "string", "enum": [ "MA", "MAPD", "PDP", "MS", "ACA", "LTC", "Individual Health", "FE", "Annuity", "Life", "Dental", "Vision", "Hospital Indemnity", "Cancer", "Critical Illness", "Accident", "Group", "Home Health Care", "International Travel" ] }, "policySubType": { "type": [ "string", "null" ], "maxLength": 100 }, "policyNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "applicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierAssignedPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "sunFireEnrollmentCode": { "type": [ "string", "null" ], "maxLength": 255 }, "connectureConfirmationNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "hiosId": { "type": [ "string", "null" ], "maxLength": 255 }, "metalLevel": { "type": [ "string", "null" ], "enum": [ "Catastrophic", "Bronze", "Expanded Bronze", "Silver", "Gold", "Platinum", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", null ] }, "applicationApprovalDate": { "description": "Application approval date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Policy effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "terminationDate": { "description": "Policy termination date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "renewalDate": { "description": "Policy renewal date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "enrollmentDate": { "description": "Policy enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "cancelledDate": { "description": "Policy cancellation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "declineReason": { "type": [ "string", "null" ] }, "declineReasonDescription": { "type": [ "string", "null" ] }, "cancellationReason": { "type": [ "string", "null" ] }, "cancellationReasonDescription": { "type": [ "string", "null" ] }, "electionPeriod": { "type": [ "string", "null" ], "enum": [ "IEP", "AEP", "OEP", "SEP", "ICEP", "MA-OEP", null ] }, "gracePeriodStartDate": { "description": "Grace period start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "paidThroughDate": { "description": "Coverage paid-through date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "ffmApplicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "ffmSubscriberId": { "type": [ "string", "null" ], "maxLength": 255 }, "aorAgentId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "aorFirstName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorLastName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentName": { "type": [ "string", "null" ], "maxLength": 255 }, "sepType": { "type": [ "string", "null" ], "maxLength": 255 }, "sepCode": { "type": [ "string", "null" ], "maxLength": 100 }, "sepStartDate": { "description": "SEP start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepEndDate": { "description": "SEP end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepDocumentationReceived": { "type": [ "boolean", "null" ] }, "sepDocumentationDate": { "description": "SEP documentation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepNotes": { "type": [ "string", "null" ] }, "monthlyPremium": { "type": [ "string", "null" ] }, "deductible": { "type": [ "string", "null" ] }, "outOfPocketMax": { "type": [ "string", "null" ] }, "subsidyAmount": { "type": [ "string", "null" ] }, "usingSubsidy": { "type": [ "boolean", "null" ] }, "premiumMode": { "type": [ "string", "null" ], "enum": [ "Monthly", "Quarterly", "Semi-Annual", "Annual", null ] }, "paymentMode": { "type": [ "string", "null" ], "enum": [ "ACH", "Credit/ debit card", "Direct bill", null ] }, "paymentMethod": { "type": [ "string", "null" ], "enum": [ "Credit Card", "Debit Card", "Check", "ACH / Bank Draft", "Money Order", "Cash", "Other", null ] }, "grossPremium": { "type": [ "string", "null" ] }, "netPremium": { "type": [ "string", "null" ] }, "initialCommission": { "type": [ "string", "null" ] }, "renewalCommission": { "type": [ "string", "null" ] }, "spifAmount": { "type": [ "string", "null" ] }, "policyLives": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "wasAgent": { "type": [ "boolean", "null" ] }, "writtenAs": { "type": [ "string", "null" ], "enum": [ "New Business", "Like Plan Change", "Unlike Plan Change", "Reinstatement", "Rewrite", null ] }, "isReplacing": { "type": [ "string", "null" ], "maxLength": 255 }, "isRewrite": { "type": [ "boolean", "null" ] }, "hospitalNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "pcpNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "ssbciVerificationRequired": { "type": [ "boolean", "null" ] }, "dailyBenefit": { "type": [ "string", "null" ] }, "eliminationPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "benefitPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "hasCola": { "type": [ "boolean", "null" ] }, "deathBenefit": { "type": [ "string", "null" ] }, "term": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "maturityDate": { "description": "Policy maturity date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "riders": { "type": [ "string", "null" ] }, "coverageLevel": { "type": [ "string", "null" ], "enum": [ "Immediate", "Graded/ROP", "Modified Level", "Standard Level", "Preferred Level", null ] }, "draftDay": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "exchangeStatus": { "type": [ "string", "null" ], "enum": [ "FFM", "SBM", "SBM FP", "OFF EXCHANGE", "PRIVATE EXCHANGE", "UNKNOWN", null ] }, "billingMethod": { "type": [ "string", "null" ], "maxLength": 100 }, "benefitReminder": { "description": "Benefit reminder date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "surveyCompleted": { "type": [ "boolean", "null" ] }, "reasonForPurchase": { "type": [ "string", "null" ] }, "policyNotes": { "type": [ "string", "null" ] }, "customFields": { "description": "Structured custom fields with definitions and values. Populated on customer detail and policy detail responses; absent elsewhere.", "type": "array", "items": { "description": "Formatted custom field with definition and record-specific value", "type": "object", "properties": { "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldDefinitionId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "description": "The actual value for this record (type determined by fieldType). Dates are represented as ISO 8601 strings.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" }, {} ] } }, "additionalProperties": false } } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "customerId", "policyType", "policySubType", "policyNumber", "applicationId", "carrierId", "carrierName", "planName", "planCode", "carrierAssignedPolicyId", "healthSherpaPolicyId", "sunFireEnrollmentCode", "connectureConfirmationNumber", "hiosId", "metalLevel", "status", "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "cancelledDate", "declineReason", "declineReasonDescription", "cancellationReason", "cancellationReasonDescription", "electionPeriod", "gracePeriodStartDate", "paidThroughDate", "ffmApplicationId", "ffmSubscriberId", "aorAgentId", "aorFirstName", "aorLastName", "aorNpn", "writingAgentNpn", "writingAgentName", "sepType", "sepCode", "sepStartDate", "sepEndDate", "sepDocumentationReceived", "sepDocumentationDate", "sepNotes", "monthlyPremium", "deductible", "outOfPocketMax", "subsidyAmount", "usingSubsidy", "premiumMode", "paymentMode", "paymentMethod", "grossPremium", "netPremium", "initialCommission", "renewalCommission", "spifAmount", "policyLives", "wasAgent", "writtenAs", "isReplacing", "isRewrite", "hospitalNetwork", "pcpNetwork", "ssbciVerificationRequired", "dailyBenefit", "eliminationPeriod", "benefitPeriod", "hasCola", "deathBenefit", "term", "maturityDate", "riders", "coverageLevel", "draftDay", "exchangeStatus", "billingMethod", "benefitReminder", "surveyCompleted", "reasonForPurchase", "policyNotes" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdPoliciesPolicyIdRequestBody": { "type": "object", "properties": { "policyType": { "type": "string", "enum": [ "MA", "MAPD", "PDP", "MS", "ACA", "LTC", "Individual Health", "FE", "Annuity", "Life", "Dental", "Vision", "Hospital Indemnity", "Cancer", "Critical Illness", "Accident", "Group", "Home Health Care", "International Travel" ] }, "policySubType": { "type": [ "string", "null" ], "maxLength": 100 }, "policyNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "applicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierAssignedPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "sunFireEnrollmentCode": { "type": [ "string", "null" ], "maxLength": 255 }, "connectureConfirmationNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "hiosId": { "type": [ "string", "null" ], "maxLength": 255 }, "metalLevel": { "type": [ "string", "null" ], "enum": [ "Catastrophic", "Bronze", "Expanded Bronze", "Silver", "Gold", "Platinum", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", null ] }, "applicationApprovalDate": { "description": "Application approval date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Policy effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "terminationDate": { "description": "Policy termination date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "renewalDate": { "description": "Policy renewal date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "enrollmentDate": { "description": "Policy enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "cancelledDate": { "description": "Policy cancellation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "declineReason": { "type": [ "string", "null" ] }, "declineReasonDescription": { "type": [ "string", "null" ] }, "cancellationReason": { "type": [ "string", "null" ] }, "cancellationReasonDescription": { "type": [ "string", "null" ] }, "electionPeriod": { "type": [ "string", "null" ], "enum": [ "IEP", "AEP", "OEP", "SEP", "ICEP", "MA-OEP", null ] }, "gracePeriodStartDate": { "description": "Grace period start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "paidThroughDate": { "description": "Coverage paid-through date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "ffmApplicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "ffmSubscriberId": { "type": [ "string", "null" ], "maxLength": 255 }, "aorAgentId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "aorFirstName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorLastName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentName": { "type": [ "string", "null" ], "maxLength": 255 }, "sepType": { "type": [ "string", "null" ], "maxLength": 255 }, "sepCode": { "type": [ "string", "null" ], "maxLength": 100 }, "sepStartDate": { "description": "SEP start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepEndDate": { "description": "SEP end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepDocumentationReceived": { "type": [ "boolean", "null" ] }, "sepDocumentationDate": { "description": "SEP documentation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepNotes": { "type": [ "string", "null" ] }, "monthlyPremium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deductible": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "outOfPocketMax": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subsidyAmount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "usingSubsidy": { "type": [ "boolean", "null" ] }, "premiumMode": { "type": [ "string", "null" ], "enum": [ "Monthly", "Quarterly", "Semi-Annual", "Annual", null ] }, "paymentMode": { "type": [ "string", "null" ], "enum": [ "ACH", "Credit/ debit card", "Direct bill", null ] }, "paymentMethod": { "type": [ "string", "null" ], "enum": [ "Credit Card", "Debit Card", "Check", "ACH / Bank Draft", "Money Order", "Cash", "Other", null ] }, "grossPremium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "netPremium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "initialCommission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "renewalCommission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "spifAmount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "policyLives": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "wasAgent": { "type": [ "boolean", "null" ] }, "writtenAs": { "type": [ "string", "null" ], "enum": [ "New Business", "Like Plan Change", "Unlike Plan Change", "Reinstatement", "Rewrite", null ] }, "isReplacing": { "type": [ "string", "null" ], "maxLength": 255 }, "isRewrite": { "type": [ "boolean", "null" ] }, "hospitalNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "pcpNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "ssbciVerificationRequired": { "type": [ "boolean", "null" ] }, "dailyBenefit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eliminationPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "benefitPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "hasCola": { "type": [ "boolean", "null" ] }, "deathBenefit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "term": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "maturityDate": { "description": "Policy maturity date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "riders": { "type": [ "string", "null" ] }, "coverageLevel": { "type": [ "string", "null" ], "enum": [ "Immediate", "Graded/ROP", "Modified Level", "Standard Level", "Preferred Level", null ] }, "draftDay": { "description": "Day of the month the premium drafts (1-31). Not a calendar date.", "examples": [ 1, 15 ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 31 }, "exchangeStatus": { "type": [ "string", "null" ], "enum": [ "FFM", "SBM", "SBM FP", "OFF EXCHANGE", "PRIVATE EXCHANGE", "UNKNOWN", null ] }, "billingMethod": { "type": [ "string", "null" ], "maxLength": 100 }, "benefitReminder": { "description": "Benefit reminder date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "surveyCompleted": { "type": [ "boolean", "null" ] }, "reasonForPurchase": { "type": [ "string", "null" ] }, "policyNotes": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false }, "PostV2CustomersIdPoliciesParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CustomersIdPoliciesPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Policy creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Policy last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "policyType": { "type": "string", "enum": [ "MA", "MAPD", "PDP", "MS", "ACA", "LTC", "Individual Health", "FE", "Annuity", "Life", "Dental", "Vision", "Hospital Indemnity", "Cancer", "Critical Illness", "Accident", "Group", "Home Health Care", "International Travel" ] }, "policySubType": { "type": [ "string", "null" ], "maxLength": 100 }, "policyNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "applicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierAssignedPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "sunFireEnrollmentCode": { "type": [ "string", "null" ], "maxLength": 255 }, "connectureConfirmationNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "hiosId": { "type": [ "string", "null" ], "maxLength": 255 }, "metalLevel": { "type": [ "string", "null" ], "enum": [ "Catastrophic", "Bronze", "Expanded Bronze", "Silver", "Gold", "Platinum", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", null ] }, "applicationApprovalDate": { "description": "Application approval date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Policy effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "terminationDate": { "description": "Policy termination date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "renewalDate": { "description": "Policy renewal date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "enrollmentDate": { "description": "Policy enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "cancelledDate": { "description": "Policy cancellation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "declineReason": { "type": [ "string", "null" ] }, "declineReasonDescription": { "type": [ "string", "null" ] }, "cancellationReason": { "type": [ "string", "null" ] }, "cancellationReasonDescription": { "type": [ "string", "null" ] }, "electionPeriod": { "type": [ "string", "null" ], "enum": [ "IEP", "AEP", "OEP", "SEP", "ICEP", "MA-OEP", null ] }, "gracePeriodStartDate": { "description": "Grace period start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "paidThroughDate": { "description": "Coverage paid-through date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "ffmApplicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "ffmSubscriberId": { "type": [ "string", "null" ], "maxLength": 255 }, "aorAgentId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "aorFirstName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorLastName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentName": { "type": [ "string", "null" ], "maxLength": 255 }, "sepType": { "type": [ "string", "null" ], "maxLength": 255 }, "sepCode": { "type": [ "string", "null" ], "maxLength": 100 }, "sepStartDate": { "description": "SEP start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepEndDate": { "description": "SEP end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepDocumentationReceived": { "type": [ "boolean", "null" ] }, "sepDocumentationDate": { "description": "SEP documentation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepNotes": { "type": [ "string", "null" ] }, "monthlyPremium": { "type": [ "string", "null" ] }, "deductible": { "type": [ "string", "null" ] }, "outOfPocketMax": { "type": [ "string", "null" ] }, "subsidyAmount": { "type": [ "string", "null" ] }, "usingSubsidy": { "type": [ "boolean", "null" ] }, "premiumMode": { "type": [ "string", "null" ], "enum": [ "Monthly", "Quarterly", "Semi-Annual", "Annual", null ] }, "paymentMode": { "type": [ "string", "null" ], "enum": [ "ACH", "Credit/ debit card", "Direct bill", null ] }, "paymentMethod": { "type": [ "string", "null" ], "enum": [ "Credit Card", "Debit Card", "Check", "ACH / Bank Draft", "Money Order", "Cash", "Other", null ] }, "grossPremium": { "type": [ "string", "null" ] }, "netPremium": { "type": [ "string", "null" ] }, "initialCommission": { "type": [ "string", "null" ] }, "renewalCommission": { "type": [ "string", "null" ] }, "spifAmount": { "type": [ "string", "null" ] }, "policyLives": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "wasAgent": { "type": [ "boolean", "null" ] }, "writtenAs": { "type": [ "string", "null" ], "enum": [ "New Business", "Like Plan Change", "Unlike Plan Change", "Reinstatement", "Rewrite", null ] }, "isReplacing": { "type": [ "string", "null" ], "maxLength": 255 }, "isRewrite": { "type": [ "boolean", "null" ] }, "hospitalNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "pcpNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "ssbciVerificationRequired": { "type": [ "boolean", "null" ] }, "dailyBenefit": { "type": [ "string", "null" ] }, "eliminationPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "benefitPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "hasCola": { "type": [ "boolean", "null" ] }, "deathBenefit": { "type": [ "string", "null" ] }, "term": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "maturityDate": { "description": "Policy maturity date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "riders": { "type": [ "string", "null" ] }, "coverageLevel": { "type": [ "string", "null" ], "enum": [ "Immediate", "Graded/ROP", "Modified Level", "Standard Level", "Preferred Level", null ] }, "draftDay": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "exchangeStatus": { "type": [ "string", "null" ], "enum": [ "FFM", "SBM", "SBM FP", "OFF EXCHANGE", "PRIVATE EXCHANGE", "UNKNOWN", null ] }, "billingMethod": { "type": [ "string", "null" ], "maxLength": 100 }, "benefitReminder": { "description": "Benefit reminder date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "surveyCompleted": { "type": [ "boolean", "null" ] }, "reasonForPurchase": { "type": [ "string", "null" ] }, "policyNotes": { "type": [ "string", "null" ] }, "customFields": { "description": "Structured custom fields with definitions and values. Populated on customer detail and policy detail responses; absent elsewhere.", "type": "array", "items": { "description": "Formatted custom field with definition and record-specific value", "type": "object", "properties": { "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldDefinitionId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "description": "The actual value for this record (type determined by fieldType). Dates are represented as ISO 8601 strings.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" }, {} ] } }, "additionalProperties": false } } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "customerId", "policyType", "policySubType", "policyNumber", "applicationId", "carrierId", "carrierName", "planName", "planCode", "carrierAssignedPolicyId", "healthSherpaPolicyId", "sunFireEnrollmentCode", "connectureConfirmationNumber", "hiosId", "metalLevel", "status", "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "cancelledDate", "declineReason", "declineReasonDescription", "cancellationReason", "cancellationReasonDescription", "electionPeriod", "gracePeriodStartDate", "paidThroughDate", "ffmApplicationId", "ffmSubscriberId", "aorAgentId", "aorFirstName", "aorLastName", "aorNpn", "writingAgentNpn", "writingAgentName", "sepType", "sepCode", "sepStartDate", "sepEndDate", "sepDocumentationReceived", "sepDocumentationDate", "sepNotes", "monthlyPremium", "deductible", "outOfPocketMax", "subsidyAmount", "usingSubsidy", "premiumMode", "paymentMode", "paymentMethod", "grossPremium", "netPremium", "initialCommission", "renewalCommission", "spifAmount", "policyLives", "wasAgent", "writtenAs", "isReplacing", "isRewrite", "hospitalNetwork", "pcpNetwork", "ssbciVerificationRequired", "dailyBenefit", "eliminationPeriod", "benefitPeriod", "hasCola", "deathBenefit", "term", "maturityDate", "riders", "coverageLevel", "draftDay", "exchangeStatus", "billingMethod", "benefitReminder", "surveyCompleted", "reasonForPurchase", "policyNotes" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdPoliciesRequestBody": { "type": "object", "properties": { "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "policyType": { "type": "string", "enum": [ "MA", "MAPD", "PDP", "MS", "ACA", "LTC", "Individual Health", "FE", "Annuity", "Life", "Dental", "Vision", "Hospital Indemnity", "Cancer", "Critical Illness", "Accident", "Group", "Home Health Care", "International Travel" ] }, "policySubType": { "type": [ "string", "null" ], "maxLength": 100 }, "policyNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "applicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "description": "Insurance carrier name. Resolved against the canonical carrier list at https://api.carecycle.ai/v2/carriers; accepts any carrier displayName or registered alias (e.g. 'UHC', 'BCBSIL', 'Cigna Health and Life Insurance Company'). Generic 'BCBS' / 'Blue Cross Blue Shield' inputs are disambiguated to the correct state plan using the customer's state.", "examples": [ "Aetna", "BCBS of TX", "UHC", "Anthem", "Florida Blue" ], "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "description": "Name of the policy", "examples": [ "Medicare Elite", "Blue Cross PPO" ], "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "description": "Plan code of the policy", "examples": [ "H1290-036-001" ], "type": [ "string", "null" ], "maxLength": 255 }, "carrierAssignedPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "sunFireEnrollmentCode": { "type": [ "string", "null" ], "maxLength": 255 }, "connectureConfirmationNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "hiosId": { "type": [ "string", "null" ], "maxLength": 255 }, "metalLevel": { "type": [ "string", "null" ], "enum": [ "Catastrophic", "Bronze", "Expanded Bronze", "Silver", "Gold", "Platinum", null ] }, "status": { "description": "The current status of the policy", "default": "Active", "type": [ "string", "null" ], "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", null ] }, "applicationApprovalDate": { "description": "Application approval date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Policy effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "terminationDate": { "description": "Policy termination date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "renewalDate": { "description": "Policy renewal date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "enrollmentDate": { "description": "Policy enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "cancelledDate": { "description": "Policy cancellation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "declineReason": { "type": [ "string", "null" ] }, "declineReasonDescription": { "type": [ "string", "null" ] }, "cancellationReason": { "type": [ "string", "null" ] }, "cancellationReasonDescription": { "type": [ "string", "null" ] }, "electionPeriod": { "type": [ "string", "null" ], "enum": [ "IEP", "AEP", "OEP", "SEP", "ICEP", "MA-OEP", null ] }, "gracePeriodStartDate": { "description": "Grace period start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "paidThroughDate": { "description": "Coverage paid-through date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "ffmApplicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "ffmSubscriberId": { "type": [ "string", "null" ], "maxLength": 255 }, "aorAgentId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "aorFirstName": { "description": "Agent Of Record First Name", "examples": [ "John", "Jane" ], "type": [ "string", "null" ], "maxLength": 255 }, "aorLastName": { "description": "Agent Of Record Last Name", "examples": [ "Doe", "Smith" ], "type": [ "string", "null" ], "maxLength": 255 }, "aorNpn": { "description": "Agent Of Record NPN", "examples": [ "123456789" ], "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentName": { "type": [ "string", "null" ], "maxLength": 255 }, "sepType": { "type": [ "string", "null" ], "maxLength": 255 }, "sepCode": { "type": [ "string", "null" ], "maxLength": 100 }, "sepStartDate": { "description": "SEP start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepEndDate": { "description": "SEP end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepDocumentationReceived": { "type": [ "boolean", "null" ] }, "sepDocumentationDate": { "description": "SEP documentation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepNotes": { "type": [ "string", "null" ] }, "monthlyPremium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deductible": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "outOfPocketMax": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subsidyAmount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "usingSubsidy": { "type": [ "boolean", "null" ] }, "premiumMode": { "type": [ "string", "null" ], "enum": [ "Monthly", "Quarterly", "Semi-Annual", "Annual", null ] }, "paymentMode": { "type": [ "string", "null" ], "enum": [ "ACH", "Credit/ debit card", "Direct bill", null ] }, "paymentMethod": { "type": [ "string", "null" ], "enum": [ "Credit Card", "Debit Card", "Check", "ACH / Bank Draft", "Money Order", "Cash", "Other", null ] }, "grossPremium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "netPremium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "initialCommission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "renewalCommission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "spifAmount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "policyLives": { "description": "Number of lives covered by the policy", "examples": [ 3 ], "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "wasAgent": { "type": [ "boolean", "null" ] }, "writtenAs": { "type": [ "string", "null" ], "enum": [ "New Business", "Like Plan Change", "Unlike Plan Change", "Reinstatement", "Rewrite", null ] }, "isReplacing": { "type": [ "string", "null" ], "maxLength": 255 }, "isRewrite": { "type": [ "boolean", "null" ] }, "hospitalNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "pcpNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "ssbciVerificationRequired": { "type": [ "boolean", "null" ] }, "dailyBenefit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eliminationPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "benefitPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "hasCola": { "type": [ "boolean", "null" ] }, "deathBenefit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "term": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "maturityDate": { "description": "Policy maturity date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "riders": { "type": [ "string", "null" ] }, "coverageLevel": { "type": [ "string", "null" ], "enum": [ "Immediate", "Graded/ROP", "Modified Level", "Standard Level", "Preferred Level", null ] }, "draftDay": { "description": "Day of the month the premium drafts (1-31). Not a calendar date.", "examples": [ 1, 15 ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 31 }, "exchangeStatus": { "type": [ "string", "null" ], "enum": [ "FFM", "SBM", "SBM FP", "OFF EXCHANGE", "PRIVATE EXCHANGE", "UNKNOWN", null ] }, "billingMethod": { "type": [ "string", "null" ], "maxLength": 100 }, "benefitReminder": { "description": "Benefit reminder date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "surveyCompleted": { "type": [ "boolean", "null" ] }, "reasonForPurchase": { "type": [ "string", "null" ] }, "policyNotes": { "type": [ "string", "null" ] }, "callHistoryId": { "description": "Optional source call context", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "policyType" ] }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdParameterCustomFieldId": { "description": "Custom field value ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdPositiveResponse": { "type": "object", "properties": { "success": { "description": "Whether the deletion was successful", "type": "boolean" }, "message": { "description": "Success message", "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdCustomFieldsCustomFieldIdParameterCustomFieldId": { "description": "Custom field value ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdCustomFieldsCustomFieldIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Custom field value creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Custom field value last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "fieldDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordType": { "type": "string", "enum": [ "customers", "policies" ] }, "textValue": { "type": [ "string", "null" ] }, "numberValue": { "type": [ "string", "null" ] }, "booleanValue": { "type": [ "boolean", "null" ] }, "dateValue": { "description": "Custom field date-time value. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "selectValue": { "type": [ "string", "null" ] }, "multiSelectValue": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "id", "createdAt", "updatedAt", "fieldDefinitionId", "recordId", "recordType", "textValue", "numberValue", "booleanValue", "dateValue", "selectValue", "multiSelectValue" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdCustomFieldsCustomFieldIdRequestBody": { "type": "object", "properties": { "textValue": { "type": [ "string", "null" ] }, "numberValue": { "type": [ "string", "null" ] }, "booleanValue": { "type": [ "boolean", "null" ] }, "dateValue": { "description": "Custom field date-time value. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "selectValue": { "type": [ "string", "null" ] }, "multiSelectValue": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [] }, "PostV2CustomersIdCustomFieldsParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CustomersIdCustomFieldsPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Custom field value creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Custom field value last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "fieldDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordType": { "type": "string", "enum": [ "customers", "policies" ] }, "textValue": { "type": [ "string", "null" ] }, "numberValue": { "type": [ "string", "null" ] }, "booleanValue": { "type": [ "boolean", "null" ] }, "dateValue": { "description": "Custom field date-time value. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "selectValue": { "type": [ "string", "null" ] }, "multiSelectValue": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "id", "createdAt", "updatedAt", "fieldDefinitionId", "recordId", "recordType", "textValue", "numberValue", "booleanValue", "dateValue", "selectValue", "multiSelectValue" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdCustomFieldsRequestBody": { "type": "object", "properties": { "fieldDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "textValue": { "type": [ "string", "null" ] }, "numberValue": { "type": [ "string", "null" ] }, "booleanValue": { "type": [ "boolean", "null" ] }, "dateValue": { "description": "Custom field date-time value. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "selectValue": { "type": [ "string", "null" ] }, "multiSelectValue": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "fieldDefinitionId" ] }, "DeleteV2CustomersIdDependentsDependentIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdDependentsDependentIdParameterDependentId": { "description": "Dependent ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdDependentsDependentIdPositiveResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false }, "DeleteV2CustomersIdDependentsDependentIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdDependentsDependentIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdDependentsDependentIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdDependentsDependentIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CustomersIdDependentsDependentIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdDependentsDependentIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdDependentsDependentIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdDependentsDependentIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdDependentsDependentIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdDependentsDependentIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdDependentsDependentIdParameterDependentId": { "description": "Dependent ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdDependentsDependentIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Dependent creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Dependent last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Dependent date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "relationshipType": { "type": [ "string", "null" ], "enum": [ "Spouse", "Child", "Parent", "Sibling", "Other", null ] }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "isCovered": { "type": [ "boolean", "null" ] }, "coverageStartDate": { "description": "Dependent coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "coverageEndDate": { "description": "Dependent coverage end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "firstName", "lastName", "middleName", "dateOfBirth", "gender", "annualIncome", "relationshipType", "phone", "email", "isCovered", "coverageStartDate", "coverageEndDate", "isActive", "notes" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdDependentsDependentIdRequestBody": { "type": "object", "properties": { "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "anyOf": [ { "anyOf": [ { "description": "Dependent date of birth. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "relationshipType": { "type": [ "string", "null" ], "enum": [ "Spouse", "Child", "Parent", "Sibling", "Other", null ] }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "isCovered": { "type": [ "boolean", "null" ] }, "coverageStartDate": { "anyOf": [ { "anyOf": [ { "description": "Dependent coverage start date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "coverageEndDate": { "anyOf": [ { "anyOf": [ { "description": "Dependent coverage end date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 } }, "required": [] }, "PostV2CustomersIdDependentsParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CustomersIdDependentsPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Dependent creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Dependent last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Dependent date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "relationshipType": { "type": [ "string", "null" ], "enum": [ "Spouse", "Child", "Parent", "Sibling", "Other", null ] }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "isCovered": { "type": [ "boolean", "null" ] }, "coverageStartDate": { "description": "Dependent coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "coverageEndDate": { "description": "Dependent coverage end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "firstName", "lastName", "middleName", "dateOfBirth", "gender", "annualIncome", "relationshipType", "phone", "email", "isCovered", "coverageStartDate", "coverageEndDate", "isActive", "notes" ], "additionalProperties": false }, "PostV2CustomersIdDependentsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdDependentsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdDependentsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdDependentsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomersIdDependentsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdDependentsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdDependentsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdDependentsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdDependentsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdDependentsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdDependentsRequestBody": { "type": "object", "properties": { "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "anyOf": [ { "anyOf": [ { "description": "Dependent date of birth. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "relationshipType": { "type": [ "string", "null" ], "enum": [ "Spouse", "Child", "Parent", "Sibling", "Other", null ] }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "isCovered": { "type": [ "boolean", "null" ] }, "coverageStartDate": { "anyOf": [ { "anyOf": [ { "description": "Dependent coverage start date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "coverageEndDate": { "anyOf": [ { "anyOf": [ { "description": "Dependent coverage end date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 } }, "required": [] }, "DeleteV2CustomersIdTagsTagIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdTagsTagIdParameterTagId": { "description": "Tag ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdTagsTagIdPositiveResponse": { "type": "object", "properties": { "success": { "description": "Whether the removal was successful", "type": "boolean" }, "message": { "description": "Success message", "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false }, "DeleteV2CustomersIdTagsTagIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdTagsTagIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdTagsTagIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdTagsTagIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CustomersIdTagsTagIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdTagsTagIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdTagsTagIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdTagsTagIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdTagsTagIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdTagsTagIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdTagsParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CustomersIdTagsPositiveResponse": { "type": "object", "properties": { "id": { "description": "Tag ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "description": "Tag display name", "type": "string" }, "color": { "description": "Color picked for the tag (red, orange, yellow, green, teal, blue, purple, pink, or gray). Null means automatic: a hue the name mentions, otherwise a stable swatch derived from the name.", "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "PostV2CustomersIdTagsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdTagsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdTagsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdTagsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomersIdTagsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdTagsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdTagsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdTagsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdTagsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdTagsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdTagsRequestBody": { "type": "object", "properties": { "name": { "description": "Tag name. Matched case-insensitively against the organization's existing tags; created if it does not exist yet.", "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "name" ] }, "GetV2CustomersIdCallsParameterPage": { "default": 1, "type": "number", "minimum": 1 }, "GetV2CustomersIdCallsParameterPerPage": { "default": 50, "type": "number", "minimum": 1, "maximum": 100 }, "GetV2CustomersIdCallsParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CustomersIdCallsParameterSortBy": { "description": "Field to sort by", "default": "createdAt", "type": "string", "enum": [ "createdAt", "disposition", "duration" ] }, "GetV2CustomersIdCallsParameterSortDirection": { "description": "Sort direction", "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "GetV2CustomersIdCallsPositiveResponse": { "type": "object", "properties": { "itemsTotal": { "type": "number" }, "currentPage": { "type": "number" }, "nextPage": { "type": [ "number", "null" ] }, "prevPage": { "type": [ "number", "null" ] }, "items": { "description": "List of call records for the customer", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "disposition": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": [ "string", "null" ], "maxLength": 255 }, "twilioSid": { "type": [ "string", "null" ] }, "service": { "type": [ "string", "null" ], "enum": [ "vapi", "mobius", "softphone", "campaign_test", null ] }, "testFlag": { "type": [ "boolean", "null" ] }, "direction": { "type": [ "string", "null" ], "enum": [ "inbound", "outbound", null ] }, "recordingUrl": { "type": [ "string", "null" ] }, "recordingId": { "type": [ "string", "null" ] }, "stereoRecordingUrl": { "type": [ "string", "null" ] }, "assistantType": { "type": [ "string", "null" ] }, "successEvaluation": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "transcript": { "type": [ "string", "null" ] }, "durationMs": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "createdAt": { "description": "Call creation time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "mainRecordingUrl": { "type": [ "string", "null" ] }, "isTestNumber": { "description": "Indicates if the call was made to a test number", "type": "boolean" }, "sourceName": { "type": [ "string", "null" ] }, "agentId": { "type": [ "string", "null" ] }, "agentName": { "type": [ "string", "null" ] } }, "required": [ "id", "campaignId", "disposition", "callerId", "twilioSid", "service", "testFlag", "direction", "recordingUrl", "recordingId", "stereoRecordingUrl", "assistantType", "successEvaluation", "summary", "transcript", "durationMs", "createdAt", "mainRecordingUrl", "isTestNumber", "sourceName", "agentId", "agentName" ], "additionalProperties": false } } }, "required": [ "itemsTotal", "currentPage", "nextPage", "prevPage", "items" ], "additionalProperties": false }, "GetV2CustomersIdCallsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdCallsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdCallsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdCallsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CustomersIdCallsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdCallsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdCallsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdCallsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdCallsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdCallsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdRelatedParameterId": { "description": "Customer the person is related to", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CustomersIdRelatedPositiveResponse": { "type": "object", "properties": { "outcome": { "description": "created: new customer on the number. restored: a deleted customer on the number came back. existing: the person was already a customer on the number (matched by clientCustomerId, MBI, or name and date of birth), nothing was created. linked: two existing customers were linked.", "type": "string", "enum": [ "created", "restored", "existing", "linked" ] }, "customer": { "description": "The newly created customer record", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Customer creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Customer last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "status": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "qualificationStatus": { "type": [ "string", "null" ], "enum": [ "Qualified", "Disqualified", "Pending Review", "Needs Information", "In Progress", null ] }, "intent": { "type": [ "string", "null" ], "enum": [ "High", "Medium", "Low", "Unknown", null ] }, "isDecisionMaker": { "type": [ "boolean", "null" ] }, "disqualificationReason": { "type": [ "string", "null" ], "maxLength": 255 }, "productInterest": { "type": [ "string", "null" ], "maxLength": 255 }, "productFamily": { "type": [ "string", "null" ], "maxLength": 255 }, "salutation": { "type": [ "string", "null" ], "maxLength": 50 }, "suffix": { "type": [ "string", "null" ], "maxLength": 50 }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "preferredName": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": "string", "maxLength": 255 }, "isPhonePrimary": { "type": "boolean" }, "lineType": { "type": [ "string", "null" ], "enum": [ "landline", "mobile", "fixedVoip", "nonFixedVoip", "personal", "tollFree", "premium", "sharedCost", "uan", "voicemail", "pager", "unknown", null ] }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "ethnicity": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "maritalStatus": { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] }, "heightInches": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weightPounds": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "smokerStatus": { "type": [ "boolean", "null" ] }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "timezone": { "type": [ "string", "null" ], "maxLength": 50 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "countyFips": { "type": [ "string", "null" ], "maxLength": 5 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "description": "Medicare Part A effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicarePartBDate": { "description": "Medicare Part B effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "householdIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyAmount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "existingCoverage": { "type": [ "string", "null" ], "enum": [ "None", "Medicare Advantage", "Original Medicare", "Medicaid", "Employer", "Marketplace/ACA", "Other", null ] }, "existingCoveragePlanName": { "type": [ "string", "null" ], "maxLength": 255 }, "existingCoverageCarrier": { "type": [ "string", "null" ], "maxLength": 255 }, "desiredCoverageStartDate": { "description": "Desired coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "currentSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "originalSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "memberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "enrollmentDate": { "description": "Customer enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Customer coverage effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "carrierAssignedCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "suppressed": { "type": "boolean" }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "lastContactedAt": { "description": "Customer last contact time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "convertedAt": { "description": "Customer conversion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "testCustomer": { "type": "boolean" }, "ssnLast4": { "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "clientId", "clientCustomerId", "status", "qualificationStatus", "intent", "isDecisionMaker", "disqualificationReason", "productInterest", "productFamily", "salutation", "suffix", "firstName", "middleName", "lastName", "preferredName", "callerId", "isPhonePrimary", "lineType", "email", "dateOfBirth", "language", "ethnicity", "gender", "maritalStatus", "heightInches", "weightPounds", "smokerStatus", "postalCode", "timezone", "state", "city", "county", "countyFips", "address", "address2", "mbiNumber", "medicareCard", "medicarePartADate", "medicarePartBDate", "medicaid", "medicaidNumber", "socialSecurityDisability", "veteran", "vaNumber", "healthSherpaCustomerId", "householdIncome", "annualIncome", "filingStatus", "dependentCount", "subsidyAmount", "subsidyEligible", "existingCoverage", "existingCoveragePlanName", "existingCoverageCarrier", "desiredCoverageStartDate", "currentSourceId", "originalSourceId", "agentName", "agentNpn", "memberId", "carrierName", "planName", "planCode", "enrollmentDate", "effectiveDate", "carrierAssignedCustomerId", "suppressed", "doNotCall", "doNotSMS", "doNotEmail", "doNotMail", "lastContactedAt", "convertedAt", "testCustomer", "ssnLast4" ], "additionalProperties": false }, "relationship": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "description": "The customer the link was added from", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "relatedCustomerId": { "description": "The customer who is the other customer's relationshipType", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "relationshipType": { "description": "What the related customer is to the customer in the path, for example spouse or child", "type": "string", "enum": [ "spouse", "child", "parent", "sibling", "power_of_attorney", "other" ] }, "createdAt": { "description": "Relationship creation time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Relationship last update time. ISO 8601 timestamp", "type": "string", "format": "date-time" } }, "required": [ "id", "customerId", "relatedCustomerId", "relationshipType", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "outcome", "customer", "relationship" ], "additionalProperties": false }, "PostV2CustomersIdRelatedNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdRelatedNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdRelatedNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdRelatedNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomersIdRelatedNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdRelatedNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdRelatedNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdRelatedNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdRelatedNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdRelatedNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdRelatedRequestBody": { "type": "object", "properties": { "relationshipType": { "description": "What the related customer is to the customer in the path, for example spouse or child", "type": "string", "enum": [ "spouse", "child", "parent", "sibling", "power_of_attorney", "other" ] }, "relatedCustomerId": { "description": "Link an existing customer instead of adding a person", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "person": { "description": "A person who shares this customer's phone number. They get the number, its call and text opt-outs, and the customer's assigned agent. Send mbiNumber, clientCustomerId (your own ID for the person), or firstName, lastName and dateOfBirth so repeat requests match them; at least one is required.", "type": "object", "properties": { "clientCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "status": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "qualificationStatus": { "type": [ "string", "null" ], "enum": [ "Qualified", "Disqualified", "Pending Review", "Needs Information", "In Progress", null ] }, "intent": { "type": [ "string", "null" ], "enum": [ "High", "Medium", "Low", "Unknown", null ] }, "isDecisionMaker": { "type": [ "boolean", "null" ] }, "disqualificationReason": { "type": [ "string", "null" ], "maxLength": 255 }, "productInterest": { "type": [ "string", "null" ], "maxLength": 255 }, "productFamily": { "type": [ "string", "null" ], "maxLength": 255 }, "salutation": { "type": [ "string", "null" ], "maxLength": 50 }, "suffix": { "type": [ "string", "null" ], "maxLength": 50 }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "preferredName": { "type": [ "string", "null" ], "maxLength": 255 }, "lineType": { "type": [ "string", "null" ], "enum": [ "landline", "mobile", "fixedVoip", "nonFixedVoip", "personal", "tollFree", "premium", "sharedCost", "uan", "voicemail", "pager", "unknown", null ] }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "anyOf": [ { "anyOf": [ { "description": "Customer date of birth. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "ethnicity": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "maritalStatus": { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] }, "heightInches": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weightPounds": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "smokerStatus": { "type": [ "boolean", "null" ] }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "timezone": { "type": [ "string", "null" ], "maxLength": 50 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "countyFips": { "type": [ "string", "null" ], "maxLength": 5 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "anyOf": [ { "anyOf": [ { "description": "Medicare Part A effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "medicarePartBDate": { "anyOf": [ { "anyOf": [ { "description": "Medicare Part B effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "medicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "householdIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyAmount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "existingCoverage": { "type": [ "string", "null" ], "enum": [ "None", "Medicare Advantage", "Original Medicare", "Medicaid", "Employer", "Marketplace/ACA", "Other", null ] }, "existingCoveragePlanName": { "type": [ "string", "null" ], "maxLength": 255 }, "existingCoverageCarrier": { "type": [ "string", "null" ], "maxLength": 255 }, "desiredCoverageStartDate": { "anyOf": [ { "anyOf": [ { "description": "Desired coverage start date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "currentSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "originalSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "enrollmentDate": { "anyOf": [ { "anyOf": [ { "description": "Customer enrollment date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "effectiveDate": { "anyOf": [ { "anyOf": [ { "description": "Customer coverage effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "carrierAssignedCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "lastContactedAt": { "description": "Customer last contact time. ISO 8601 timestamp", "anyOf": [ { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "convertedAt": { "description": "Customer conversion time. ISO 8601 timestamp", "anyOf": [ { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "testCustomer": { "type": "boolean" } } }, "sharePhone": { "description": "With relatedCustomerId: move that customer onto this customer's phone number as a related customer. They take the number's call and SMS opt-outs.", "type": "boolean" }, "isPrimaryForPhone": { "description": "Make the related customer the primary contact for the shared phone number: inbound calls, texts and outreach then go to them. Both customers must share the number. Applies only when the person or link is new; a repeat request does not change the primary.", "type": "boolean" } }, "required": [ "relationshipType" ] }, "PostV2CustomersIdMakePrimaryParameterId": { "description": "Customer who becomes the primary for their number", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2CustomersIdMakePrimaryPositiveResponse": { "type": "object", "properties": { "customer": { "description": "The newly created customer record", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Customer creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Customer last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "status": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "qualificationStatus": { "type": [ "string", "null" ], "enum": [ "Qualified", "Disqualified", "Pending Review", "Needs Information", "In Progress", null ] }, "intent": { "type": [ "string", "null" ], "enum": [ "High", "Medium", "Low", "Unknown", null ] }, "isDecisionMaker": { "type": [ "boolean", "null" ] }, "disqualificationReason": { "type": [ "string", "null" ], "maxLength": 255 }, "productInterest": { "type": [ "string", "null" ], "maxLength": 255 }, "productFamily": { "type": [ "string", "null" ], "maxLength": 255 }, "salutation": { "type": [ "string", "null" ], "maxLength": 50 }, "suffix": { "type": [ "string", "null" ], "maxLength": 50 }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "preferredName": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": "string", "maxLength": 255 }, "isPhonePrimary": { "type": "boolean" }, "lineType": { "type": [ "string", "null" ], "enum": [ "landline", "mobile", "fixedVoip", "nonFixedVoip", "personal", "tollFree", "premium", "sharedCost", "uan", "voicemail", "pager", "unknown", null ] }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "ethnicity": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "maritalStatus": { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] }, "heightInches": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weightPounds": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "smokerStatus": { "type": [ "boolean", "null" ] }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "timezone": { "type": [ "string", "null" ], "maxLength": 50 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "countyFips": { "type": [ "string", "null" ], "maxLength": 5 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "description": "Medicare Part A effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicarePartBDate": { "description": "Medicare Part B effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "householdIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyAmount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "existingCoverage": { "type": [ "string", "null" ], "enum": [ "None", "Medicare Advantage", "Original Medicare", "Medicaid", "Employer", "Marketplace/ACA", "Other", null ] }, "existingCoveragePlanName": { "type": [ "string", "null" ], "maxLength": 255 }, "existingCoverageCarrier": { "type": [ "string", "null" ], "maxLength": 255 }, "desiredCoverageStartDate": { "description": "Desired coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "currentSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "originalSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "memberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "enrollmentDate": { "description": "Customer enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Customer coverage effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "carrierAssignedCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "suppressed": { "type": "boolean" }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "lastContactedAt": { "description": "Customer last contact time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "convertedAt": { "description": "Customer conversion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "testCustomer": { "type": "boolean" }, "ssnLast4": { "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "clientId", "clientCustomerId", "status", "qualificationStatus", "intent", "isDecisionMaker", "disqualificationReason", "productInterest", "productFamily", "salutation", "suffix", "firstName", "middleName", "lastName", "preferredName", "callerId", "isPhonePrimary", "lineType", "email", "dateOfBirth", "language", "ethnicity", "gender", "maritalStatus", "heightInches", "weightPounds", "smokerStatus", "postalCode", "timezone", "state", "city", "county", "countyFips", "address", "address2", "mbiNumber", "medicareCard", "medicarePartADate", "medicarePartBDate", "medicaid", "medicaidNumber", "socialSecurityDisability", "veteran", "vaNumber", "healthSherpaCustomerId", "householdIncome", "annualIncome", "filingStatus", "dependentCount", "subsidyAmount", "subsidyEligible", "existingCoverage", "existingCoveragePlanName", "existingCoverageCarrier", "desiredCoverageStartDate", "currentSourceId", "originalSourceId", "agentName", "agentNpn", "memberId", "carrierName", "planName", "planCode", "enrollmentDate", "effectiveDate", "carrierAssignedCustomerId", "suppressed", "doNotCall", "doNotSMS", "doNotEmail", "doNotMail", "lastContactedAt", "convertedAt", "testCustomer", "ssnLast4" ], "additionalProperties": false }, "previousPrimary": { "description": "The newly created customer record" } }, "required": [ "customer", "previousPrimary" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersIdMakePrimaryRequestBody": { "type": "object", "properties": {}, "required": [] }, "DeleteV2CustomersIdRelationshipsRelationshipIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdRelationshipsRelationshipIdParameterRelationshipId": { "description": "Relationship ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdRelationshipsRelationshipIdPositiveResponse": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdRelationshipsRelationshipIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdRelationshipsRelationshipIdParameterRelationshipId": { "description": "Relationship ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdRelationshipsRelationshipIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "description": "The customer the link was added from", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "relatedCustomerId": { "description": "The customer who is the other customer's relationshipType", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "relationshipType": { "description": "What the related customer is to the customer in the path, for example spouse or child", "type": "string", "enum": [ "spouse", "child", "parent", "sibling", "power_of_attorney", "other" ] }, "createdAt": { "description": "Relationship creation time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Relationship last update time. ISO 8601 timestamp", "type": "string", "format": "date-time" } }, "required": [ "id", "customerId", "relatedCustomerId", "relationshipType", "createdAt", "updatedAt" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRelationshipsRelationshipIdRequestBody": { "type": "object", "properties": { "relationshipType": { "description": "What the related customer is to the customer in the path, for example spouse or child", "type": "string", "enum": [ "spouse", "child", "parent", "sibling", "power_of_attorney", "other" ] } }, "required": [ "relationshipType" ] }, "GetV2CustomersIdRelationshipsParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CustomersIdRelationshipsPositiveResponse": { "type": "object", "properties": { "relationships": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "description": "The customer the link was added from", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "relatedCustomerId": { "description": "The customer who is the other customer's relationshipType", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "relationshipType": { "description": "What the related customer is to the customer in the path, for example spouse or child", "type": "string", "enum": [ "spouse", "child", "parent", "sibling", "power_of_attorney", "other" ] }, "createdAt": { "description": "Relationship creation time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Relationship last update time. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "direction": { "description": "outgoing: the listed customer is this customer's relationshipType. incoming: this customer is the listed customer's relationshipType.", "type": "string", "enum": [ "outgoing", "incoming" ] }, "customer": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "callerId": { "type": [ "string", "null" ] }, "isPhonePrimary": { "type": "boolean" }, "sharesPhone": { "description": "Whether they share this customer's phone number", "type": "boolean" } }, "required": [ "id", "firstName", "lastName", "dateOfBirth", "callerId", "isPhonePrimary", "sharesPhone" ], "additionalProperties": false } }, "required": [ "id", "customerId", "relatedCustomerId", "relationshipType", "createdAt", "updatedAt", "direction", "customer" ], "additionalProperties": false } } }, "required": [ "relationships" ], "additionalProperties": false }, "GetV2CustomersIdRelationshipsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdRelationshipsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdRelationshipsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdRelationshipsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CustomersIdRelationshipsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdRelationshipsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdRelationshipsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdRelationshipsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdRelationshipsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdRelationshipsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomersIdPositiveResponse": { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "message": { "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false }, "DeleteV2CustomersIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CustomersIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomersIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CustomersIdPositiveResponse": { "description": "Customer", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Customer creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Customer last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "status": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "qualificationStatus": { "type": [ "string", "null" ], "enum": [ "Qualified", "Disqualified", "Pending Review", "Needs Information", "In Progress", null ] }, "intent": { "type": [ "string", "null" ], "enum": [ "High", "Medium", "Low", "Unknown", null ] }, "isDecisionMaker": { "type": [ "boolean", "null" ] }, "disqualificationReason": { "type": [ "string", "null" ], "maxLength": 255 }, "productInterest": { "type": [ "string", "null" ], "maxLength": 255 }, "productFamily": { "type": [ "string", "null" ], "maxLength": 255 }, "salutation": { "type": [ "string", "null" ], "maxLength": 50 }, "suffix": { "type": [ "string", "null" ], "maxLength": 50 }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "preferredName": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": "string", "maxLength": 255 }, "isPhonePrimary": { "type": "boolean" }, "lineType": { "type": [ "string", "null" ], "enum": [ "landline", "mobile", "fixedVoip", "nonFixedVoip", "personal", "tollFree", "premium", "sharedCost", "uan", "voicemail", "pager", "unknown", null ] }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "ethnicity": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "maritalStatus": { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] }, "heightInches": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weightPounds": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "smokerStatus": { "type": [ "boolean", "null" ] }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "timezone": { "type": [ "string", "null" ], "maxLength": 50 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "countyFips": { "type": [ "string", "null" ], "maxLength": 5 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "description": "Medicare Part A effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicarePartBDate": { "description": "Medicare Part B effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "householdIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyAmount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "existingCoverage": { "type": [ "string", "null" ], "enum": [ "None", "Medicare Advantage", "Original Medicare", "Medicaid", "Employer", "Marketplace/ACA", "Other", null ] }, "existingCoveragePlanName": { "type": [ "string", "null" ], "maxLength": 255 }, "existingCoverageCarrier": { "type": [ "string", "null" ], "maxLength": 255 }, "desiredCoverageStartDate": { "description": "Desired coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "currentSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "originalSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "memberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "enrollmentDate": { "description": "Customer enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Customer coverage effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "carrierAssignedCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "suppressed": { "type": "boolean" }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "lastContactedAt": { "description": "Customer last contact time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "convertedAt": { "description": "Customer conversion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "testCustomer": { "type": "boolean" }, "ssnLast4": { "type": [ "string", "null" ] }, "carrierSmsConsent": { "type": "object", "properties": { "blocked": { "type": "boolean" }, "recordedAt": { "description": "Carrier SMS consent record time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "source": { "type": [ "string", "null" ] }, "matchedKeyword": { "type": [ "string", "null" ] } }, "required": [ "blocked", "recordedAt", "source", "matchedKeyword" ], "additionalProperties": false }, "phoneNumberCustomerCount": { "description": "Customers on this phone number, this one included. Call and SMS opt-outs apply to all of them.", "type": "number" }, "phonePrimaryCustomerId": { "description": "The primary customer on this phone number. Texts with the number live on their conversation.", "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "totalCalls": { "description": "Total number of calls made to this customer", "type": "number" }, "lastCallDate": { "description": "Most recent call time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "lastCallDisposition": { "description": "Disposition of the most recent call", "type": [ "string", "null" ] }, "campaigns": { "description": "Campaigns this customer is enrolled in", "default": [], "type": "array", "items": { "type": "object", "properties": { "customerCampaignId": { "type": "string" }, "campaignId": { "type": "string" }, "campaignName": { "type": "string" }, "campaignStatus": { "type": "string" }, "campaignLifecycleStatus": { "type": "string" }, "campaignIsReceptionist": { "type": "boolean" }, "isActive": { "type": "boolean" }, "attempts": { "type": "number" }, "pulseNodeId": { "type": [ "string", "null" ] }, "pulseNodeType": { "type": [ "string", "null" ] }, "pulseStatus": { "type": [ "string", "null" ] }, "pulseLastTransitionAt": { "description": "Campaign workflow last transition time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "pulseWaitNodeId": { "description": "Wait step the customer entered on their latest Pulse transition (Live View counts them there; pulseNodeId is the step that runs after it). Detail endpoint only.", "type": [ "string", "null" ] }, "statusReason": { "description": "Client-safe explanation of why the customer was failed/skipped", "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "category": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" } }, "required": [ "code", "category", "label", "description" ], "additionalProperties": false } }, "required": [ "customerCampaignId", "campaignId", "campaignName", "campaignStatus", "campaignLifecycleStatus", "campaignIsReceptionist", "isActive" ], "additionalProperties": false } }, "source": { "description": "Source information for this customer", "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "sourceId": { "type": "string" } }, "required": [ "id", "name", "sourceId" ], "additionalProperties": false }, "customFields": { "description": "Structured custom fields with definitions and values", "default": [], "type": "array", "items": { "description": "Formatted custom field with definition and record-specific value", "type": "object", "properties": { "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldDefinitionId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "description": "The actual value for this record (type determined by fieldType). Dates are represented as ISO 8601 strings.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" }, {} ] } }, "additionalProperties": false } }, "policies": { "description": "List of policies associated with the customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Policy creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Policy last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "policyType": { "type": "string", "enum": [ "MA", "MAPD", "PDP", "MS", "ACA", "LTC", "Individual Health", "FE", "Annuity", "Life", "Dental", "Vision", "Hospital Indemnity", "Cancer", "Critical Illness", "Accident", "Group", "Home Health Care", "International Travel" ] }, "policySubType": { "type": [ "string", "null" ], "maxLength": 100 }, "policyNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "applicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierAssignedPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "sunFireEnrollmentCode": { "type": [ "string", "null" ], "maxLength": 255 }, "connectureConfirmationNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "hiosId": { "type": [ "string", "null" ], "maxLength": 255 }, "metalLevel": { "type": [ "string", "null" ], "enum": [ "Catastrophic", "Bronze", "Expanded Bronze", "Silver", "Gold", "Platinum", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", null ] }, "applicationApprovalDate": { "description": "Application approval date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Policy effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "terminationDate": { "description": "Policy termination date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "renewalDate": { "description": "Policy renewal date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "enrollmentDate": { "description": "Policy enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "cancelledDate": { "description": "Policy cancellation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "declineReason": { "type": [ "string", "null" ] }, "declineReasonDescription": { "type": [ "string", "null" ] }, "cancellationReason": { "type": [ "string", "null" ] }, "cancellationReasonDescription": { "type": [ "string", "null" ] }, "electionPeriod": { "type": [ "string", "null" ], "enum": [ "IEP", "AEP", "OEP", "SEP", "ICEP", "MA-OEP", null ] }, "gracePeriodStartDate": { "description": "Grace period start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "paidThroughDate": { "description": "Coverage paid-through date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "ffmApplicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "ffmSubscriberId": { "type": [ "string", "null" ], "maxLength": 255 }, "aorAgentId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "aorFirstName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorLastName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentName": { "type": [ "string", "null" ], "maxLength": 255 }, "sepType": { "type": [ "string", "null" ], "maxLength": 255 }, "sepCode": { "type": [ "string", "null" ], "maxLength": 100 }, "sepStartDate": { "description": "SEP start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepEndDate": { "description": "SEP end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepDocumentationReceived": { "type": [ "boolean", "null" ] }, "sepDocumentationDate": { "description": "SEP documentation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepNotes": { "type": [ "string", "null" ] }, "monthlyPremium": { "type": [ "string", "null" ] }, "deductible": { "type": [ "string", "null" ] }, "outOfPocketMax": { "type": [ "string", "null" ] }, "subsidyAmount": { "type": [ "string", "null" ] }, "usingSubsidy": { "type": [ "boolean", "null" ] }, "premiumMode": { "type": [ "string", "null" ], "enum": [ "Monthly", "Quarterly", "Semi-Annual", "Annual", null ] }, "paymentMode": { "type": [ "string", "null" ], "enum": [ "ACH", "Credit/ debit card", "Direct bill", null ] }, "paymentMethod": { "type": [ "string", "null" ], "enum": [ "Credit Card", "Debit Card", "Check", "ACH / Bank Draft", "Money Order", "Cash", "Other", null ] }, "grossPremium": { "type": [ "string", "null" ] }, "netPremium": { "type": [ "string", "null" ] }, "initialCommission": { "type": [ "string", "null" ] }, "renewalCommission": { "type": [ "string", "null" ] }, "spifAmount": { "type": [ "string", "null" ] }, "policyLives": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "wasAgent": { "type": [ "boolean", "null" ] }, "writtenAs": { "type": [ "string", "null" ], "enum": [ "New Business", "Like Plan Change", "Unlike Plan Change", "Reinstatement", "Rewrite", null ] }, "isReplacing": { "type": [ "string", "null" ], "maxLength": 255 }, "isRewrite": { "type": [ "boolean", "null" ] }, "hospitalNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "pcpNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "ssbciVerificationRequired": { "type": [ "boolean", "null" ] }, "dailyBenefit": { "type": [ "string", "null" ] }, "eliminationPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "benefitPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "hasCola": { "type": [ "boolean", "null" ] }, "deathBenefit": { "type": [ "string", "null" ] }, "term": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "maturityDate": { "description": "Policy maturity date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "riders": { "type": [ "string", "null" ] }, "coverageLevel": { "type": [ "string", "null" ], "enum": [ "Immediate", "Graded/ROP", "Modified Level", "Standard Level", "Preferred Level", null ] }, "draftDay": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "exchangeStatus": { "type": [ "string", "null" ], "enum": [ "FFM", "SBM", "SBM FP", "OFF EXCHANGE", "PRIVATE EXCHANGE", "UNKNOWN", null ] }, "billingMethod": { "type": [ "string", "null" ], "maxLength": 100 }, "benefitReminder": { "description": "Benefit reminder date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "surveyCompleted": { "type": [ "boolean", "null" ] }, "reasonForPurchase": { "type": [ "string", "null" ] }, "policyNotes": { "type": [ "string", "null" ] }, "customFields": { "description": "Structured custom fields with definitions and values. Populated on customer detail and policy detail responses; absent elsewhere.", "type": "array", "items": { "description": "Formatted custom field with definition and record-specific value", "type": "object", "properties": { "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldDefinitionId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "description": "The actual value for this record (type determined by fieldType). Dates are represented as ISO 8601 strings.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" }, {} ] } }, "additionalProperties": false } } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "customerId", "policyType", "policySubType", "policyNumber", "applicationId", "carrierId", "carrierName", "planName", "planCode", "carrierAssignedPolicyId", "healthSherpaPolicyId", "sunFireEnrollmentCode", "connectureConfirmationNumber", "hiosId", "metalLevel", "status", "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "cancelledDate", "declineReason", "declineReasonDescription", "cancellationReason", "cancellationReasonDescription", "electionPeriod", "gracePeriodStartDate", "paidThroughDate", "ffmApplicationId", "ffmSubscriberId", "aorAgentId", "aorFirstName", "aorLastName", "aorNpn", "writingAgentNpn", "writingAgentName", "sepType", "sepCode", "sepStartDate", "sepEndDate", "sepDocumentationReceived", "sepDocumentationDate", "sepNotes", "monthlyPremium", "deductible", "outOfPocketMax", "subsidyAmount", "usingSubsidy", "premiumMode", "paymentMode", "paymentMethod", "grossPremium", "netPremium", "initialCommission", "renewalCommission", "spifAmount", "policyLives", "wasAgent", "writtenAs", "isReplacing", "isRewrite", "hospitalNetwork", "pcpNetwork", "ssbciVerificationRequired", "dailyBenefit", "eliminationPeriod", "benefitPeriod", "hasCola", "deathBenefit", "term", "maturityDate", "riders", "coverageLevel", "draftDay", "exchangeStatus", "billingMethod", "benefitReminder", "surveyCompleted", "reasonForPurchase", "policyNotes" ], "additionalProperties": false } }, "planCrosswalk": { "description": "Latest completed plan crosswalk containing this customer", "type": [ "object", "null" ], "properties": { "cohort": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "fromYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "toYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "completedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "governmentCrosswalkLoaded": { "type": "boolean" } }, "required": [ "id", "name", "fromYear", "toYear", "completedAt", "governmentCrosswalkLoaded" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fromPlanId": { "type": [ "string", "null" ] }, "toPlanId": { "type": [ "string", "null" ] }, "outcome": { "type": "string", "enum": [ "renewed", "consolidated", "split", "service_area_reduction", "terminated", "not_found", "skipped" ] }, "primaryBucket": { "type": [ "string", "null" ], "enum": [ "plan_terminated", "service_area_reduction", "plan_not_found", "plan_split", "plan_consolidated", "benefit_loss", "premium_increase", "moop_increase", "deductible_increase", "star_rating_decrease", "no_material_change", null ] }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "plan_terminated", "service_area_reduction", "plan_not_found", "plan_split", "plan_consolidated", "benefit_loss", "premium_increase", "moop_increase", "deductible_increase", "star_rating_decrease", "no_material_change" ] } }, "skipReason": { "type": [ "string", "null" ], "enum": [ "no_plan_code", "unparseable_plan_code", "plan_not_found", "county_unresolved", "county_outside_plan_area", "plan_name_unmatched", "plan_name_ambiguous", null ] }, "planCodeOnFile": { "type": [ "string", "null" ] }, "fromPlanName": { "type": [ "string", "null" ] }, "carrier": { "type": [ "string", "null" ] }, "toPlanName": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "changeSummary": { "type": [ "string", "null" ] }, "changes": { "type": [ "object", "null" ], "properties": { "monthlyPremium": { "type": "object", "properties": { "from": { "type": [ "number", "null" ] }, "to": { "type": [ "number", "null" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "maxOutOfPocket": { "type": "object", "properties": { "from": { "type": [ "number", "null" ] }, "to": { "type": [ "number", "null" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "healthDeductible": { "type": "object", "properties": { "from": { "type": [ "number", "null" ] }, "to": { "type": [ "number", "null" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "drugDeductible": { "type": "object", "properties": { "from": { "type": [ "number", "null" ] }, "to": { "type": [ "number", "null" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "starRating": { "type": "object", "properties": { "from": { "type": [ "number", "null" ] }, "to": { "type": [ "number", "null" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "benefitsLost": { "type": "array", "items": { "type": "string" } }, "benefitsGained": { "type": "array", "items": { "type": "string" } }, "successorPlanIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "monthlyPremium", "maxOutOfPocket", "healthDeductible", "drugDeductible", "starRating", "benefitsLost", "benefitsGained", "successorPlanIds" ], "additionalProperties": false }, "recommendations": { "type": "array", "items": { "type": "object", "properties": { "planId": { "type": "string" }, "planName": { "type": [ "string", "null" ] }, "differences": { "type": "array", "items": { "type": "string" } } }, "required": [ "planId", "planName", "differences" ], "additionalProperties": false } } }, "required": [ "id", "customerId", "fromPlanId", "toPlanId", "outcome", "primaryBucket", "impacts", "skipReason", "planCodeOnFile", "fromPlanName", "carrier", "toPlanName", "county", "changeSummary", "changes", "recommendations" ], "additionalProperties": false } } }, "required": [ "cohort", "items" ], "additionalProperties": false }, "displayPolicyId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "prescriptions": { "description": "List of prescription names associated with the customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Prescription creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Prescription last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "dosage": { "type": [ "string", "null" ], "maxLength": 100 }, "frequency": { "type": [ "string", "null" ], "maxLength": 100 }, "route": { "type": [ "string", "null" ], "enum": [ "Oral", "Topical", "Injection", "Inhalation", "Sublingual", "Rectal", "Intravenous", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Expired", "Discontinued", null ] }, "connectureDrugId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureDosageId": { "type": [ "string", "null" ], "maxLength": 64 }, "connecturePackageId": { "type": [ "string", "null" ], "maxLength": 32 }, "ndc": { "type": [ "string", "null" ], "maxLength": 11 }, "dosageName": { "type": [ "string", "null" ], "maxLength": 255 }, "drugTypeId": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "userQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "metricQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "daysSupply": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "packageDescription": { "type": [ "string", "null" ], "maxLength": 255 }, "packageSize": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "packageQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "name", "dosage", "frequency", "route", "status", "connectureDrugId", "connectureDosageId", "connecturePackageId", "ndc", "dosageName", "drugTypeId", "userQuantity", "metricQuantity", "daysSupply", "packageDescription", "packageSize", "packageQuantity" ], "additionalProperties": false } }, "providers": { "description": "List of providers associated with the customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Provider creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Provider last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "providerType": { "type": "string", "enum": [ "Primary Care", "Specialist", "Hospital", "Pharmacy" ] }, "specialty": { "type": [ "string", "null" ], "maxLength": 255 }, "providerName": { "type": [ "string", "null" ], "maxLength": 255 }, "practiceName": { "type": [ "string", "null" ], "maxLength": 255 }, "npi": { "type": [ "string", "null" ], "maxLength": 50 }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "fax": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "isPrimaryProvider": { "type": [ "boolean", "null" ] }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 }, "connectureProviderId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureAddressId": { "type": [ "string", "null" ], "maxLength": 64 }, "isIndividual": { "type": [ "boolean", "null" ] } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "providerType", "specialty", "providerName", "practiceName", "npi", "phone", "fax", "email", "address", "address2", "city", "state", "postalCode", "isPrimaryProvider", "isActive", "notes", "connectureProviderId", "connectureAddressId", "isIndividual" ], "additionalProperties": false } }, "scopeOfAppointments": { "description": "List of scope of appointments associated with the customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Scope of appointment creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Scope of appointment last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "productsDiscussed": { "type": [ "string", "null" ] }, "planTypes": { "type": [ "string", "null" ] }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "consentGiven": { "type": [ "boolean", "null" ] }, "consentDate": { "description": "Scope of appointment consent time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "status": { "type": [ "string", "null" ], "enum": [ "Pending", "Completed", "Expired", "Cancelled", null ] }, "expirationDate": { "description": "Scope of appointment expiration date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "isValid": { "type": [ "boolean", "null" ] }, "documentUrl": { "type": [ "string", "null" ], "maxLength": 500 }, "notes": { "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "productsDiscussed", "planTypes", "agentName", "agentNpn", "consentGiven", "consentDate", "status", "expirationDate", "isValid", "documentUrl", "notes" ], "additionalProperties": false } }, "dependents": { "description": "List of dependents associated with the customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Dependent creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Dependent last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Dependent date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "relationshipType": { "type": [ "string", "null" ], "enum": [ "Spouse", "Child", "Parent", "Sibling", "Other", null ] }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "isCovered": { "type": [ "boolean", "null" ] }, "coverageStartDate": { "description": "Dependent coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "coverageEndDate": { "description": "Dependent coverage end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "firstName", "lastName", "middleName", "dateOfBirth", "gender", "annualIncome", "relationshipType", "phone", "email", "isCovered", "coverageStartDate", "coverageEndDate", "isActive", "notes" ], "additionalProperties": false } }, "assignedMember": { "description": "The team member assigned to this customer", "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "image": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "email", "image" ], "additionalProperties": false }, "tags": { "description": "Tags assigned to this customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "color": { "description": "Color picked for the tag; null means automatic", "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "clientId", "clientCustomerId", "status", "qualificationStatus", "intent", "isDecisionMaker", "disqualificationReason", "productInterest", "productFamily", "salutation", "suffix", "firstName", "middleName", "lastName", "preferredName", "callerId", "isPhonePrimary", "lineType", "email", "dateOfBirth", "language", "ethnicity", "gender", "maritalStatus", "heightInches", "weightPounds", "smokerStatus", "postalCode", "timezone", "state", "city", "county", "countyFips", "address", "address2", "mbiNumber", "medicareCard", "medicarePartADate", "medicarePartBDate", "medicaid", "medicaidNumber", "socialSecurityDisability", "veteran", "vaNumber", "healthSherpaCustomerId", "householdIncome", "annualIncome", "filingStatus", "dependentCount", "subsidyAmount", "subsidyEligible", "existingCoverage", "existingCoveragePlanName", "existingCoverageCarrier", "desiredCoverageStartDate", "currentSourceId", "originalSourceId", "agentName", "agentNpn", "memberId", "carrierName", "planName", "planCode", "enrollmentDate", "effectiveDate", "carrierAssignedCustomerId", "suppressed", "doNotCall", "doNotSMS", "doNotEmail", "doNotMail", "lastContactedAt", "convertedAt", "testCustomer", "ssnLast4", "campaigns", "customFields", "policies", "displayPolicyId", "prescriptions", "providers", "scopeOfAppointments", "dependents", "tags" ], "additionalProperties": false }, "GetV2CustomersIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CustomersIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdParameterId": { "description": "Customer ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2CustomersIdPositiveResponse": { "description": "Updated customer record", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Customer creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Customer last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "status": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "qualificationStatus": { "type": [ "string", "null" ], "enum": [ "Qualified", "Disqualified", "Pending Review", "Needs Information", "In Progress", null ] }, "intent": { "type": [ "string", "null" ], "enum": [ "High", "Medium", "Low", "Unknown", null ] }, "isDecisionMaker": { "type": [ "boolean", "null" ] }, "disqualificationReason": { "type": [ "string", "null" ], "maxLength": 255 }, "productInterest": { "type": [ "string", "null" ], "maxLength": 255 }, "productFamily": { "type": [ "string", "null" ], "maxLength": 255 }, "salutation": { "type": [ "string", "null" ], "maxLength": 50 }, "suffix": { "type": [ "string", "null" ], "maxLength": 50 }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "preferredName": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": "string", "maxLength": 255 }, "isPhonePrimary": { "type": "boolean" }, "lineType": { "type": [ "string", "null" ], "enum": [ "landline", "mobile", "fixedVoip", "nonFixedVoip", "personal", "tollFree", "premium", "sharedCost", "uan", "voicemail", "pager", "unknown", null ] }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "ethnicity": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "maritalStatus": { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] }, "heightInches": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weightPounds": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "smokerStatus": { "type": [ "boolean", "null" ] }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "timezone": { "type": [ "string", "null" ], "maxLength": 50 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "countyFips": { "type": [ "string", "null" ], "maxLength": 5 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "description": "Medicare Part A effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicarePartBDate": { "description": "Medicare Part B effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "householdIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyAmount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "existingCoverage": { "type": [ "string", "null" ], "enum": [ "None", "Medicare Advantage", "Original Medicare", "Medicaid", "Employer", "Marketplace/ACA", "Other", null ] }, "existingCoveragePlanName": { "type": [ "string", "null" ], "maxLength": 255 }, "existingCoverageCarrier": { "type": [ "string", "null" ], "maxLength": 255 }, "desiredCoverageStartDate": { "description": "Desired coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "currentSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "originalSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "memberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "enrollmentDate": { "description": "Customer enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Customer coverage effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "carrierAssignedCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "suppressed": { "type": "boolean" }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "lastContactedAt": { "description": "Customer last contact time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "convertedAt": { "description": "Customer conversion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "testCustomer": { "type": "boolean" }, "ssnLast4": { "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "clientId", "clientCustomerId", "status", "qualificationStatus", "intent", "isDecisionMaker", "disqualificationReason", "productInterest", "productFamily", "salutation", "suffix", "firstName", "middleName", "lastName", "preferredName", "callerId", "isPhonePrimary", "lineType", "email", "dateOfBirth", "language", "ethnicity", "gender", "maritalStatus", "heightInches", "weightPounds", "smokerStatus", "postalCode", "timezone", "state", "city", "county", "countyFips", "address", "address2", "mbiNumber", "medicareCard", "medicarePartADate", "medicarePartBDate", "medicaid", "medicaidNumber", "socialSecurityDisability", "veteran", "vaNumber", "healthSherpaCustomerId", "householdIncome", "annualIncome", "filingStatus", "dependentCount", "subsidyAmount", "subsidyEligible", "existingCoverage", "existingCoveragePlanName", "existingCoverageCarrier", "desiredCoverageStartDate", "currentSourceId", "originalSourceId", "agentName", "agentNpn", "memberId", "carrierName", "planName", "planCode", "enrollmentDate", "effectiveDate", "carrierAssignedCustomerId", "suppressed", "doNotCall", "doNotSMS", "doNotEmail", "doNotMail", "lastContactedAt", "convertedAt", "testCustomer", "ssnLast4" ], "additionalProperties": false }, "PatchV2CustomersIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2CustomersIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2CustomersIdRequestBody": { "type": "object", "properties": { "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "status": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "qualificationStatus": { "type": [ "string", "null" ], "enum": [ "Qualified", "Disqualified", "Pending Review", "Needs Information", "In Progress", null ] }, "intent": { "type": [ "string", "null" ], "enum": [ "High", "Medium", "Low", "Unknown", null ] }, "isDecisionMaker": { "type": [ "boolean", "null" ] }, "disqualificationReason": { "type": [ "string", "null" ], "maxLength": 255 }, "productInterest": { "type": [ "string", "null" ], "maxLength": 255 }, "productFamily": { "type": [ "string", "null" ], "maxLength": 255 }, "salutation": { "type": [ "string", "null" ], "maxLength": 50 }, "suffix": { "type": [ "string", "null" ], "maxLength": 50 }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "preferredName": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": "string", "maxLength": 255 }, "lineType": { "type": [ "string", "null" ], "enum": [ "landline", "mobile", "fixedVoip", "nonFixedVoip", "personal", "tollFree", "premium", "sharedCost", "uan", "voicemail", "pager", "unknown", null ] }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "anyOf": [ { "anyOf": [ { "description": "Customer date of birth. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "ethnicity": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "maritalStatus": { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] }, "heightInches": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weightPounds": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "smokerStatus": { "type": [ "boolean", "null" ] }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "timezone": { "type": [ "string", "null" ], "maxLength": 50 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "countyFips": { "type": [ "string", "null" ], "maxLength": 5 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "anyOf": [ { "anyOf": [ { "description": "Medicare Part A effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "medicarePartBDate": { "anyOf": [ { "anyOf": [ { "description": "Medicare Part B effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "medicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "householdIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyAmount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "existingCoverage": { "type": [ "string", "null" ], "enum": [ "None", "Medicare Advantage", "Original Medicare", "Medicaid", "Employer", "Marketplace/ACA", "Other", null ] }, "existingCoveragePlanName": { "type": [ "string", "null" ], "maxLength": 255 }, "existingCoverageCarrier": { "type": [ "string", "null" ], "maxLength": 255 }, "desiredCoverageStartDate": { "anyOf": [ { "anyOf": [ { "description": "Desired coverage start date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "currentSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "originalSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "memberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "enrollmentDate": { "anyOf": [ { "anyOf": [ { "description": "Customer enrollment date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "effectiveDate": { "anyOf": [ { "anyOf": [ { "description": "Customer coverage effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "carrierAssignedCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "lastContactedAt": { "description": "Customer last contact time. ISO 8601 timestamp", "anyOf": [ { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "convertedAt": { "description": "Customer conversion time. ISO 8601 timestamp", "anyOf": [ { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "testCustomer": { "type": "boolean" } }, "required": [] }, "GetV2CustomersParameterPage": { "default": 1, "type": "number", "minimum": 1 }, "GetV2CustomersParameterPerPage": { "default": 50, "type": "number", "minimum": 1, "maximum": 100 }, "GetV2CustomersParameterSortBy": { "description": "Field to sort by", "default": "createdAt", "type": "string", "enum": [ "createdAt", "firstName", "lastName", "callerId", "dateOfBirth", "lastContactedAt", "enrollmentDate", "effectiveDate", "location", "sourceName", "tags", "activeCampaigns", "activePolicies", "totalCalls", "clientCustomerId", "planName", "carrierName", "policyStatus", "assignedTo" ] }, "GetV2CustomersParameterSortDirection": { "description": "Sort direction", "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "GetV2CustomersParameterCustomFieldKeys": { "type": "string" }, "GetV2CustomersParameterSearch": { "description": "Search query for filtering customers by customer ID, client customer ID, name, phone, email, ZIP code, MBI, or policy enrollment code.", "type": "string" }, "GetV2CustomersParameterSearchFields": { "description": "Comma-separated list of columns whose displayed text the search also matches: location, source, tags, campaigns, planName, carrierName, policyStatus, or customField: for a text, select, or multi-select custom field. Location matches a full state name; the others need a search of 3+ characters. Unknown entries are ignored.", "type": "string" }, "GetV2CustomersParameterIncludeTestNumbers": { "description": "Include test phone numbers in results", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "GetV2CustomersParameterSourceIds": { "description": "Filter customers by source IDs (comma-separated)", "type": "string" }, "GetV2CustomersParameterTagIds": { "description": "Filter customers by known tag IDs (comma-separated, OR logic)", "type": "string" }, "GetV2CustomersParameterCampaignIds": { "description": "Filter customers by campaign IDs (comma-separated, OR logic)", "type": "string" }, "GetV2CustomersParameterCampaignIdMatchMode": { "description": "How campaignIds is matched. 'include' (default): customers enrolled in any of the campaigns, in any status. 'exclude': customers who have NEVER been enrolled in any of the campaigns (no customerCampaign row for them, in any status) - use to target the book that has not yet touched a campaign.", "default": "include", "type": "string", "enum": [ "include", "exclude" ] }, "GetV2CustomersParameterCampaignStatuses": { "description": "Filter customers by customerCampaign status (comma-separated, OR logic - matches if customer has any of these statuses in any campaign)", "type": "string" }, "GetV2CustomersParameterCampaignAttemptState": { "description": "Filter campaign customers by whether they have prior attempts", "type": "string", "enum": [ "no_attempts", "has_attempts" ] }, "GetV2CustomersParameterCampaignFailureReason": { "description": "Filter customers by their customerCampaign canonical failure reason code (comma-separated, OR logic). Use with campaignIds to drill into a single campaign's exit reason.", "type": "string" }, "GetV2CustomersParameterPulseNodeId": { "description": "Filter customers by their current Pulse node ID", "type": "string" }, "GetV2CustomersParameterPolicyStatuses": { "description": "Filter customers by policy status (comma-separated, OR logic). Valid values: Active, Placed, Pending, Pending Effectuation, Pending Followup, Suspended, Cancelled, Terminated, Future Cancel, Deceased, Not Approved", "type": "string" }, "GetV2CustomersParameterCoverageState": { "description": "Exclude customers with active coverage, or with active/pending coverage", "type": "string", "enum": [ "no_active", "no_active_or_pending" ] }, "GetV2CustomersParameterAssignedToMemberIds": { "description": "Filter customers by assigned member IDs (comma-separated, OR logic). Use 'unassigned' to filter customers with no assignee.", "type": "string" }, "GetV2CustomersParameterCustomerStatuses": { "description": "Filter customers by customer status (comma-separated, OR logic). Valid values: Lead, Active, Inactive", "type": "string" }, "GetV2CustomersParameterDateField": { "description": "Which date the startDate/endDate range filters on: customer creation, or a policy date. Policy-derived conditions in the request must all match the same policy.", "default": "createdAt", "type": "string", "enum": [ "createdAt", "effectiveDate", "enrollmentDate", "paidThroughDate", "gracePeriodStartDate", "cancelledDate" ] }, "GetV2CustomersParameterStartDate": { "description": "Inclusive start bound per dateField: YYYY-MM-DD at UTC midnight or an exact ISO timestamp. Policy DATE values represent UTC midnight.", "type": "string", "anyOf": [ { "description": "YYYY-MM-DDTHH:mm:ss.sssZ", "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?)?Z?$", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } ] }, "GetV2CustomersParameterEndDate": { "description": "End bound per dateField. YYYY-MM-DD includes that UTC calendar day; a full ISO timestamp is exact and exclusive.", "type": "string" }, "GetV2CustomersParameterLastCallStartDate": { "description": "Inclusive call start bound: YYYY-MM-DD at UTC midnight or an exact ISO timestamp.", "type": "string", "anyOf": [ { "description": "YYYY-MM-DDTHH:mm:ss.sssZ", "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?)?Z?$", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } ] }, "GetV2CustomersParameterLastCallEndDate": { "description": "Call end bound. YYYY-MM-DD includes that UTC calendar day; a full ISO timestamp is exact and exclusive.", "type": "string" }, "GetV2CustomersParameterLastCallDispositions": { "description": "Filter customers by the disposition of their most recent call (comma-separated, OR logic). Calls with system error dispositions are ignored, matching the list's Last Contact column.", "type": "string" }, "GetV2CustomersParameterNegatedFilters": { "description": "List filters to invert, comma-separated (campaignStatuses, lastCallDispositions). campaignStatuses: customers with NO enrollment in those statuses (scoped to campaignIds in include mode, so campaignIds=X&campaignStatuses=completed&negatedFilters=campaignStatuses is \"in campaign X and not completed there\"). lastCallDispositions: customers whose last call has none of them, including customers never called.", "type": "string" }, "GetV2CustomersParameterContactPermissions": { "description": "Contact permission conditions, comma-separated and ANDed (can_call, do_not_call, can_text, do_not_text). A suppressed customer counts as both do_not_call and do_not_text, matching the list's icons.", "type": "string" }, "GetV2CustomersParameterTotalCalls": { "description": "Compare the customer's call count, counted like the list's Total Calls column: operator:count (eq, neq, gt, gte, lt, lte), or between:min:max (inclusive). Example: gte:2.", "type": "string" }, "GetV2CustomersParameterStates": { "description": "Filter customers by US state (comma-separated, OR logic)", "type": "string" }, "GetV2CustomersParameterCounties": { "description": "Filter customers by county (comma-separated, OR logic)", "type": "string" }, "GetV2CustomersParameterPolicyTypes": { "description": "Filter customers who have a policy of any of these types (comma-separated, OR logic). Valid values: MA, MAPD, PDP, MS, ACA, LTC, Individual Health, FE, Annuity, Life, Dental, Vision, Hospital Indemnity, Cancer, Critical Illness, Accident, Group, Home Health Care, International Travel", "type": "string" }, "GetV2CustomersParameterTurning65Window": { "description": "Filter customers whose 65th birthday falls within the next 3/6/12 months (Medicare aging-in)", "type": "string", "enum": [ "3_months", "6_months", "1_year" ] }, "GetV2CustomersParameterSubsidyOperator": { "description": "Comparison for the policy subsidy amount filter. Requires subsidyValue (and subsidyValueTo when 'between').", "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "between" ] }, "GetV2CustomersParameterSubsidyValue": { "description": "Subsidy amount to compare against (dollars). For 'between', this is the lower bound.", "type": "number" }, "GetV2CustomersParameterSubsidyValueTo": { "description": "Upper bound for the 'between' subsidy comparison.", "type": "number" }, "GetV2CustomersParameterCustomFieldFilters": { "description": "Filter customers by custom field values (ANDed). JSON array of { key, operator, value? }. Operators: eq, neq, gt, gte, lt, lte, is_empty, is_not_empty.", "type": "string" }, "GetV2CustomersParameterSortCustomFieldKey": { "description": "When set, sort by this custom field's value (key from GET /v2/custom-fields) using sortDirection, overriding sortBy.", "type": "string" }, "GetV2CustomersPositiveResponse": { "type": "object", "properties": { "itemsTotal": { "type": "number" }, "currentPage": { "type": "number" }, "nextPage": { "type": [ "number", "null" ] }, "prevPage": { "type": [ "number", "null" ] }, "items": { "description": "List of customers", "type": "array", "items": { "description": "Customer", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Customer creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Customer last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "status": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "qualificationStatus": { "type": [ "string", "null" ], "enum": [ "Qualified", "Disqualified", "Pending Review", "Needs Information", "In Progress", null ] }, "intent": { "type": [ "string", "null" ], "enum": [ "High", "Medium", "Low", "Unknown", null ] }, "isDecisionMaker": { "type": [ "boolean", "null" ] }, "disqualificationReason": { "type": [ "string", "null" ], "maxLength": 255 }, "productInterest": { "type": [ "string", "null" ], "maxLength": 255 }, "productFamily": { "type": [ "string", "null" ], "maxLength": 255 }, "salutation": { "type": [ "string", "null" ], "maxLength": 50 }, "suffix": { "type": [ "string", "null" ], "maxLength": 50 }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "preferredName": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": "string", "maxLength": 255 }, "isPhonePrimary": { "type": "boolean" }, "lineType": { "type": [ "string", "null" ], "enum": [ "landline", "mobile", "fixedVoip", "nonFixedVoip", "personal", "tollFree", "premium", "sharedCost", "uan", "voicemail", "pager", "unknown", null ] }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "ethnicity": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "maritalStatus": { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] }, "heightInches": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weightPounds": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "smokerStatus": { "type": [ "boolean", "null" ] }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "timezone": { "type": [ "string", "null" ], "maxLength": 50 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "countyFips": { "type": [ "string", "null" ], "maxLength": 5 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "description": "Medicare Part A effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicarePartBDate": { "description": "Medicare Part B effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "householdIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyAmount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "existingCoverage": { "type": [ "string", "null" ], "enum": [ "None", "Medicare Advantage", "Original Medicare", "Medicaid", "Employer", "Marketplace/ACA", "Other", null ] }, "existingCoveragePlanName": { "type": [ "string", "null" ], "maxLength": 255 }, "existingCoverageCarrier": { "type": [ "string", "null" ], "maxLength": 255 }, "desiredCoverageStartDate": { "description": "Desired coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "currentSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "originalSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "memberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "enrollmentDate": { "description": "Customer enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Customer coverage effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "carrierAssignedCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "suppressed": { "type": "boolean" }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "lastContactedAt": { "description": "Customer last contact time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "convertedAt": { "description": "Customer conversion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "testCustomer": { "type": "boolean" }, "ssnLast4": { "type": [ "string", "null" ] }, "carrierSmsConsent": { "type": "object", "properties": { "blocked": { "type": "boolean" }, "recordedAt": { "description": "Carrier SMS consent record time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "source": { "type": [ "string", "null" ] }, "matchedKeyword": { "type": [ "string", "null" ] } }, "required": [ "blocked", "recordedAt", "source", "matchedKeyword" ], "additionalProperties": false }, "phoneNumberCustomerCount": { "description": "Customers on this phone number, this one included. Call and SMS opt-outs apply to all of them.", "type": "number" }, "phonePrimaryCustomerId": { "description": "The primary customer on this phone number. Texts with the number live on their conversation.", "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "totalCalls": { "description": "Total number of calls made to this customer", "type": "number" }, "lastCallDate": { "description": "Most recent call time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "lastCallDisposition": { "description": "Disposition of the most recent call", "type": [ "string", "null" ] }, "campaigns": { "description": "Campaigns this customer is enrolled in", "default": [], "type": "array", "items": { "type": "object", "properties": { "customerCampaignId": { "type": "string" }, "campaignId": { "type": "string" }, "campaignName": { "type": "string" }, "campaignStatus": { "type": "string" }, "campaignLifecycleStatus": { "type": "string" }, "campaignIsReceptionist": { "type": "boolean" }, "isActive": { "type": "boolean" }, "attempts": { "type": "number" }, "pulseNodeId": { "type": [ "string", "null" ] }, "pulseNodeType": { "type": [ "string", "null" ] }, "pulseStatus": { "type": [ "string", "null" ] }, "pulseLastTransitionAt": { "description": "Campaign workflow last transition time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "pulseWaitNodeId": { "description": "Wait step the customer entered on their latest Pulse transition (Live View counts them there; pulseNodeId is the step that runs after it). Detail endpoint only.", "type": [ "string", "null" ] }, "statusReason": { "description": "Client-safe explanation of why the customer was failed/skipped", "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "category": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" } }, "required": [ "code", "category", "label", "description" ], "additionalProperties": false } }, "required": [ "customerCampaignId", "campaignId", "campaignName", "campaignStatus", "campaignLifecycleStatus", "campaignIsReceptionist", "isActive" ], "additionalProperties": false } }, "source": { "description": "Source information for this customer", "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "sourceId": { "type": "string" } }, "required": [ "id", "name", "sourceId" ], "additionalProperties": false }, "customFields": { "description": "Structured custom fields with definitions and values", "default": [], "type": "array", "items": { "description": "Formatted custom field with definition and record-specific value", "type": "object", "properties": { "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldDefinitionId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "description": "The actual value for this record (type determined by fieldType). Dates are represented as ISO 8601 strings.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" }, {} ] } }, "additionalProperties": false } }, "policies": { "description": "List of policies associated with the customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Policy creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Policy last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "policyType": { "type": "string", "enum": [ "MA", "MAPD", "PDP", "MS", "ACA", "LTC", "Individual Health", "FE", "Annuity", "Life", "Dental", "Vision", "Hospital Indemnity", "Cancer", "Critical Illness", "Accident", "Group", "Home Health Care", "International Travel" ] }, "policySubType": { "type": [ "string", "null" ], "maxLength": 100 }, "policyNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "applicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierAssignedPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "sunFireEnrollmentCode": { "type": [ "string", "null" ], "maxLength": 255 }, "connectureConfirmationNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "hiosId": { "type": [ "string", "null" ], "maxLength": 255 }, "metalLevel": { "type": [ "string", "null" ], "enum": [ "Catastrophic", "Bronze", "Expanded Bronze", "Silver", "Gold", "Platinum", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", null ] }, "applicationApprovalDate": { "description": "Application approval date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Policy effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "terminationDate": { "description": "Policy termination date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "renewalDate": { "description": "Policy renewal date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "enrollmentDate": { "description": "Policy enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "cancelledDate": { "description": "Policy cancellation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "declineReason": { "type": [ "string", "null" ] }, "declineReasonDescription": { "type": [ "string", "null" ] }, "cancellationReason": { "type": [ "string", "null" ] }, "cancellationReasonDescription": { "type": [ "string", "null" ] }, "electionPeriod": { "type": [ "string", "null" ], "enum": [ "IEP", "AEP", "OEP", "SEP", "ICEP", "MA-OEP", null ] }, "gracePeriodStartDate": { "description": "Grace period start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "paidThroughDate": { "description": "Coverage paid-through date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "ffmApplicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "ffmSubscriberId": { "type": [ "string", "null" ], "maxLength": 255 }, "aorAgentId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "aorFirstName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorLastName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentName": { "type": [ "string", "null" ], "maxLength": 255 }, "sepType": { "type": [ "string", "null" ], "maxLength": 255 }, "sepCode": { "type": [ "string", "null" ], "maxLength": 100 }, "sepStartDate": { "description": "SEP start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepEndDate": { "description": "SEP end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepDocumentationReceived": { "type": [ "boolean", "null" ] }, "sepDocumentationDate": { "description": "SEP documentation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepNotes": { "type": [ "string", "null" ] }, "monthlyPremium": { "type": [ "string", "null" ] }, "deductible": { "type": [ "string", "null" ] }, "outOfPocketMax": { "type": [ "string", "null" ] }, "subsidyAmount": { "type": [ "string", "null" ] }, "usingSubsidy": { "type": [ "boolean", "null" ] }, "premiumMode": { "type": [ "string", "null" ], "enum": [ "Monthly", "Quarterly", "Semi-Annual", "Annual", null ] }, "paymentMode": { "type": [ "string", "null" ], "enum": [ "ACH", "Credit/ debit card", "Direct bill", null ] }, "paymentMethod": { "type": [ "string", "null" ], "enum": [ "Credit Card", "Debit Card", "Check", "ACH / Bank Draft", "Money Order", "Cash", "Other", null ] }, "grossPremium": { "type": [ "string", "null" ] }, "netPremium": { "type": [ "string", "null" ] }, "initialCommission": { "type": [ "string", "null" ] }, "renewalCommission": { "type": [ "string", "null" ] }, "spifAmount": { "type": [ "string", "null" ] }, "policyLives": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "wasAgent": { "type": [ "boolean", "null" ] }, "writtenAs": { "type": [ "string", "null" ], "enum": [ "New Business", "Like Plan Change", "Unlike Plan Change", "Reinstatement", "Rewrite", null ] }, "isReplacing": { "type": [ "string", "null" ], "maxLength": 255 }, "isRewrite": { "type": [ "boolean", "null" ] }, "hospitalNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "pcpNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "ssbciVerificationRequired": { "type": [ "boolean", "null" ] }, "dailyBenefit": { "type": [ "string", "null" ] }, "eliminationPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "benefitPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "hasCola": { "type": [ "boolean", "null" ] }, "deathBenefit": { "type": [ "string", "null" ] }, "term": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "maturityDate": { "description": "Policy maturity date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "riders": { "type": [ "string", "null" ] }, "coverageLevel": { "type": [ "string", "null" ], "enum": [ "Immediate", "Graded/ROP", "Modified Level", "Standard Level", "Preferred Level", null ] }, "draftDay": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "exchangeStatus": { "type": [ "string", "null" ], "enum": [ "FFM", "SBM", "SBM FP", "OFF EXCHANGE", "PRIVATE EXCHANGE", "UNKNOWN", null ] }, "billingMethod": { "type": [ "string", "null" ], "maxLength": 100 }, "benefitReminder": { "description": "Benefit reminder date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "surveyCompleted": { "type": [ "boolean", "null" ] }, "reasonForPurchase": { "type": [ "string", "null" ] }, "policyNotes": { "type": [ "string", "null" ] }, "customFields": { "description": "Structured custom fields with definitions and values. Populated on customer detail and policy detail responses; absent elsewhere.", "type": "array", "items": { "description": "Formatted custom field with definition and record-specific value", "type": "object", "properties": { "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldDefinitionId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "description": "The actual value for this record (type determined by fieldType). Dates are represented as ISO 8601 strings.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" }, {} ] } }, "additionalProperties": false } } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "customerId", "policyType", "policySubType", "policyNumber", "applicationId", "carrierId", "carrierName", "planName", "planCode", "carrierAssignedPolicyId", "healthSherpaPolicyId", "sunFireEnrollmentCode", "connectureConfirmationNumber", "hiosId", "metalLevel", "status", "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "cancelledDate", "declineReason", "declineReasonDescription", "cancellationReason", "cancellationReasonDescription", "electionPeriod", "gracePeriodStartDate", "paidThroughDate", "ffmApplicationId", "ffmSubscriberId", "aorAgentId", "aorFirstName", "aorLastName", "aorNpn", "writingAgentNpn", "writingAgentName", "sepType", "sepCode", "sepStartDate", "sepEndDate", "sepDocumentationReceived", "sepDocumentationDate", "sepNotes", "monthlyPremium", "deductible", "outOfPocketMax", "subsidyAmount", "usingSubsidy", "premiumMode", "paymentMode", "paymentMethod", "grossPremium", "netPremium", "initialCommission", "renewalCommission", "spifAmount", "policyLives", "wasAgent", "writtenAs", "isReplacing", "isRewrite", "hospitalNetwork", "pcpNetwork", "ssbciVerificationRequired", "dailyBenefit", "eliminationPeriod", "benefitPeriod", "hasCola", "deathBenefit", "term", "maturityDate", "riders", "coverageLevel", "draftDay", "exchangeStatus", "billingMethod", "benefitReminder", "surveyCompleted", "reasonForPurchase", "policyNotes" ], "additionalProperties": false } }, "planCrosswalk": { "description": "Latest completed plan crosswalk containing this customer", "type": [ "object", "null" ], "properties": { "cohort": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "fromYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "toYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "completedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "governmentCrosswalkLoaded": { "type": "boolean" } }, "required": [ "id", "name", "fromYear", "toYear", "completedAt", "governmentCrosswalkLoaded" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fromPlanId": { "type": [ "string", "null" ] }, "toPlanId": { "type": [ "string", "null" ] }, "outcome": { "type": "string", "enum": [ "renewed", "consolidated", "split", "service_area_reduction", "terminated", "not_found", "skipped" ] }, "primaryBucket": { "type": [ "string", "null" ], "enum": [ "plan_terminated", "service_area_reduction", "plan_not_found", "plan_split", "plan_consolidated", "benefit_loss", "premium_increase", "moop_increase", "deductible_increase", "star_rating_decrease", "no_material_change", null ] }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "plan_terminated", "service_area_reduction", "plan_not_found", "plan_split", "plan_consolidated", "benefit_loss", "premium_increase", "moop_increase", "deductible_increase", "star_rating_decrease", "no_material_change" ] } }, "skipReason": { "type": [ "string", "null" ], "enum": [ "no_plan_code", "unparseable_plan_code", "plan_not_found", "county_unresolved", "county_outside_plan_area", "plan_name_unmatched", "plan_name_ambiguous", null ] }, "planCodeOnFile": { "type": [ "string", "null" ] }, "fromPlanName": { "type": [ "string", "null" ] }, "carrier": { "type": [ "string", "null" ] }, "toPlanName": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "changeSummary": { "type": [ "string", "null" ] }, "changes": { "type": [ "object", "null" ], "properties": { "monthlyPremium": { "type": "object", "properties": { "from": { "type": [ "number", "null" ] }, "to": { "type": [ "number", "null" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "maxOutOfPocket": { "type": "object", "properties": { "from": { "type": [ "number", "null" ] }, "to": { "type": [ "number", "null" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "healthDeductible": { "type": "object", "properties": { "from": { "type": [ "number", "null" ] }, "to": { "type": [ "number", "null" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "drugDeductible": { "type": "object", "properties": { "from": { "type": [ "number", "null" ] }, "to": { "type": [ "number", "null" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "starRating": { "type": "object", "properties": { "from": { "type": [ "number", "null" ] }, "to": { "type": [ "number", "null" ] } }, "required": [ "from", "to" ], "additionalProperties": false }, "benefitsLost": { "type": "array", "items": { "type": "string" } }, "benefitsGained": { "type": "array", "items": { "type": "string" } }, "successorPlanIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "monthlyPremium", "maxOutOfPocket", "healthDeductible", "drugDeductible", "starRating", "benefitsLost", "benefitsGained", "successorPlanIds" ], "additionalProperties": false }, "recommendations": { "type": "array", "items": { "type": "object", "properties": { "planId": { "type": "string" }, "planName": { "type": [ "string", "null" ] }, "differences": { "type": "array", "items": { "type": "string" } } }, "required": [ "planId", "planName", "differences" ], "additionalProperties": false } } }, "required": [ "id", "customerId", "fromPlanId", "toPlanId", "outcome", "primaryBucket", "impacts", "skipReason", "planCodeOnFile", "fromPlanName", "carrier", "toPlanName", "county", "changeSummary", "changes", "recommendations" ], "additionalProperties": false } } }, "required": [ "cohort", "items" ], "additionalProperties": false }, "displayPolicyId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "prescriptions": { "description": "List of prescription names associated with the customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Prescription creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Prescription last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "dosage": { "type": [ "string", "null" ], "maxLength": 100 }, "frequency": { "type": [ "string", "null" ], "maxLength": 100 }, "route": { "type": [ "string", "null" ], "enum": [ "Oral", "Topical", "Injection", "Inhalation", "Sublingual", "Rectal", "Intravenous", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Expired", "Discontinued", null ] }, "connectureDrugId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureDosageId": { "type": [ "string", "null" ], "maxLength": 64 }, "connecturePackageId": { "type": [ "string", "null" ], "maxLength": 32 }, "ndc": { "type": [ "string", "null" ], "maxLength": 11 }, "dosageName": { "type": [ "string", "null" ], "maxLength": 255 }, "drugTypeId": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "userQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "metricQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "daysSupply": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "packageDescription": { "type": [ "string", "null" ], "maxLength": 255 }, "packageSize": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 }, "packageQuantity": { "type": [ "number", "null" ], "minimum": -140737488355328, "maximum": 140737488355327 } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "name", "dosage", "frequency", "route", "status", "connectureDrugId", "connectureDosageId", "connecturePackageId", "ndc", "dosageName", "drugTypeId", "userQuantity", "metricQuantity", "daysSupply", "packageDescription", "packageSize", "packageQuantity" ], "additionalProperties": false } }, "providers": { "description": "List of providers associated with the customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Provider creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Provider last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "providerType": { "type": "string", "enum": [ "Primary Care", "Specialist", "Hospital", "Pharmacy" ] }, "specialty": { "type": [ "string", "null" ], "maxLength": 255 }, "providerName": { "type": [ "string", "null" ], "maxLength": 255 }, "practiceName": { "type": [ "string", "null" ], "maxLength": 255 }, "npi": { "type": [ "string", "null" ], "maxLength": 50 }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "fax": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "isPrimaryProvider": { "type": [ "boolean", "null" ] }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 }, "connectureProviderId": { "type": [ "string", "null" ], "maxLength": 32 }, "connectureAddressId": { "type": [ "string", "null" ], "maxLength": 64 }, "isIndividual": { "type": [ "boolean", "null" ] } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "providerType", "specialty", "providerName", "practiceName", "npi", "phone", "fax", "email", "address", "address2", "city", "state", "postalCode", "isPrimaryProvider", "isActive", "notes", "connectureProviderId", "connectureAddressId", "isIndividual" ], "additionalProperties": false } }, "scopeOfAppointments": { "description": "List of scope of appointments associated with the customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Scope of appointment creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Scope of appointment last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "productsDiscussed": { "type": [ "string", "null" ] }, "planTypes": { "type": [ "string", "null" ] }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "consentGiven": { "type": [ "boolean", "null" ] }, "consentDate": { "description": "Scope of appointment consent time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "status": { "type": [ "string", "null" ], "enum": [ "Pending", "Completed", "Expired", "Cancelled", null ] }, "expirationDate": { "description": "Scope of appointment expiration date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "isValid": { "type": [ "boolean", "null" ] }, "documentUrl": { "type": [ "string", "null" ], "maxLength": 500 }, "notes": { "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "productsDiscussed", "planTypes", "agentName", "agentNpn", "consentGiven", "consentDate", "status", "expirationDate", "isValid", "documentUrl", "notes" ], "additionalProperties": false } }, "dependents": { "description": "List of dependents associated with the customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Dependent creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Dependent last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Dependent date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "relationshipType": { "type": [ "string", "null" ], "enum": [ "Spouse", "Child", "Parent", "Sibling", "Other", null ] }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "isCovered": { "type": [ "boolean", "null" ] }, "coverageStartDate": { "description": "Dependent coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "coverageEndDate": { "description": "Dependent coverage end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "isActive": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 } }, "required": [ "id", "createdAt", "updatedAt", "customerId", "firstName", "lastName", "middleName", "dateOfBirth", "gender", "annualIncome", "relationshipType", "phone", "email", "isCovered", "coverageStartDate", "coverageEndDate", "isActive", "notes" ], "additionalProperties": false } }, "assignedMember": { "description": "The team member assigned to this customer", "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "image": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "email", "image" ], "additionalProperties": false }, "tags": { "description": "Tags assigned to this customer", "default": [], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "color": { "description": "Color picked for the tag; null means automatic", "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "clientId", "clientCustomerId", "status", "qualificationStatus", "intent", "isDecisionMaker", "disqualificationReason", "productInterest", "productFamily", "salutation", "suffix", "firstName", "middleName", "lastName", "preferredName", "callerId", "isPhonePrimary", "lineType", "email", "dateOfBirth", "language", "ethnicity", "gender", "maritalStatus", "heightInches", "weightPounds", "smokerStatus", "postalCode", "timezone", "state", "city", "county", "countyFips", "address", "address2", "mbiNumber", "medicareCard", "medicarePartADate", "medicarePartBDate", "medicaid", "medicaidNumber", "socialSecurityDisability", "veteran", "vaNumber", "healthSherpaCustomerId", "householdIncome", "annualIncome", "filingStatus", "dependentCount", "subsidyAmount", "subsidyEligible", "existingCoverage", "existingCoveragePlanName", "existingCoverageCarrier", "desiredCoverageStartDate", "currentSourceId", "originalSourceId", "agentName", "agentNpn", "memberId", "carrierName", "planName", "planCode", "enrollmentDate", "effectiveDate", "carrierAssignedCustomerId", "suppressed", "doNotCall", "doNotSMS", "doNotEmail", "doNotMail", "lastContactedAt", "convertedAt", "testCustomer", "ssnLast4", "campaigns", "customFields", "policies", "displayPolicyId", "prescriptions", "providers", "scopeOfAppointments", "dependents", "tags" ], "additionalProperties": false } } }, "required": [ "itemsTotal", "currentPage", "nextPage", "prevPage", "items" ], "additionalProperties": false }, "GetV2CustomersNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CustomersNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomersNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersPositiveResponse": { "description": "The newly created customer record", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Customer creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Customer last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "status": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "qualificationStatus": { "type": [ "string", "null" ], "enum": [ "Qualified", "Disqualified", "Pending Review", "Needs Information", "In Progress", null ] }, "intent": { "type": [ "string", "null" ], "enum": [ "High", "Medium", "Low", "Unknown", null ] }, "isDecisionMaker": { "type": [ "boolean", "null" ] }, "disqualificationReason": { "type": [ "string", "null" ], "maxLength": 255 }, "productInterest": { "type": [ "string", "null" ], "maxLength": 255 }, "productFamily": { "type": [ "string", "null" ], "maxLength": 255 }, "salutation": { "type": [ "string", "null" ], "maxLength": 50 }, "suffix": { "type": [ "string", "null" ], "maxLength": 50 }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "preferredName": { "type": [ "string", "null" ], "maxLength": 255 }, "callerId": { "type": "string", "maxLength": 255 }, "isPhonePrimary": { "type": "boolean" }, "lineType": { "type": [ "string", "null" ], "enum": [ "landline", "mobile", "fixedVoip", "nonFixedVoip", "personal", "tollFree", "premium", "sharedCost", "uan", "voicemail", "pager", "unknown", null ] }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "ethnicity": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "maritalStatus": { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] }, "heightInches": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weightPounds": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "smokerStatus": { "type": [ "boolean", "null" ] }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "timezone": { "type": [ "string", "null" ], "maxLength": 50 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "countyFips": { "type": [ "string", "null" ], "maxLength": 5 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "description": "Medicare Part A effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicarePartBDate": { "description": "Medicare Part B effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "householdIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyAmount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "existingCoverage": { "type": [ "string", "null" ], "enum": [ "None", "Medicare Advantage", "Original Medicare", "Medicaid", "Employer", "Marketplace/ACA", "Other", null ] }, "existingCoveragePlanName": { "type": [ "string", "null" ], "maxLength": 255 }, "existingCoverageCarrier": { "type": [ "string", "null" ], "maxLength": 255 }, "desiredCoverageStartDate": { "description": "Desired coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "currentSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "originalSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "memberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "enrollmentDate": { "description": "Customer enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Customer coverage effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "carrierAssignedCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "suppressed": { "type": "boolean" }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "lastContactedAt": { "description": "Customer last contact time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "convertedAt": { "description": "Customer conversion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "testCustomer": { "type": "boolean" }, "ssnLast4": { "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "clientId", "clientCustomerId", "status", "qualificationStatus", "intent", "isDecisionMaker", "disqualificationReason", "productInterest", "productFamily", "salutation", "suffix", "firstName", "middleName", "lastName", "preferredName", "callerId", "isPhonePrimary", "lineType", "email", "dateOfBirth", "language", "ethnicity", "gender", "maritalStatus", "heightInches", "weightPounds", "smokerStatus", "postalCode", "timezone", "state", "city", "county", "countyFips", "address", "address2", "mbiNumber", "medicareCard", "medicarePartADate", "medicarePartBDate", "medicaid", "medicaidNumber", "socialSecurityDisability", "veteran", "vaNumber", "healthSherpaCustomerId", "householdIncome", "annualIncome", "filingStatus", "dependentCount", "subsidyAmount", "subsidyEligible", "existingCoverage", "existingCoveragePlanName", "existingCoverageCarrier", "desiredCoverageStartDate", "currentSourceId", "originalSourceId", "agentName", "agentNpn", "memberId", "carrierName", "planName", "planCode", "enrollmentDate", "effectiveDate", "carrierAssignedCustomerId", "suppressed", "doNotCall", "doNotSMS", "doNotEmail", "doNotMail", "lastContactedAt", "convertedAt", "testCustomer", "ssnLast4" ], "additionalProperties": false }, "PostV2CustomersNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomersNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomersRequestBody": { "description": "Fields for creating a new customer", "type": "object", "properties": { "clientCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "status": { "type": [ "string", "null" ], "enum": [ "Lead", "Active", "Inactive", null ] }, "qualificationStatus": { "type": [ "string", "null" ], "enum": [ "Qualified", "Disqualified", "Pending Review", "Needs Information", "In Progress", null ] }, "intent": { "type": [ "string", "null" ], "enum": [ "High", "Medium", "Low", "Unknown", null ] }, "isDecisionMaker": { "type": [ "boolean", "null" ] }, "disqualificationReason": { "type": [ "string", "null" ], "maxLength": 255 }, "productInterest": { "type": [ "string", "null" ], "maxLength": 255 }, "productFamily": { "type": [ "string", "null" ], "maxLength": 255 }, "salutation": { "type": [ "string", "null" ], "maxLength": 50 }, "suffix": { "type": [ "string", "null" ], "maxLength": 50 }, "firstName": { "type": [ "string", "null" ], "maxLength": 255 }, "middleName": { "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "type": [ "string", "null" ], "maxLength": 255 }, "preferredName": { "type": [ "string", "null" ], "maxLength": 255 }, "lineType": { "type": [ "string", "null" ], "enum": [ "landline", "mobile", "fixedVoip", "nonFixedVoip", "personal", "tollFree", "premium", "sharedCost", "uan", "voicemail", "pager", "unknown", null ] }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "anyOf": [ { "anyOf": [ { "description": "Customer date of birth. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "ethnicity": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "maritalStatus": { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] }, "heightInches": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weightPounds": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "smokerStatus": { "type": [ "boolean", "null" ] }, "postalCode": { "type": [ "string", "null" ], "maxLength": 20 }, "timezone": { "type": [ "string", "null" ], "maxLength": 50 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "countyFips": { "type": [ "string", "null" ], "maxLength": 5 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "anyOf": [ { "anyOf": [ { "description": "Medicare Part A effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "medicarePartBDate": { "anyOf": [ { "anyOf": [ { "description": "Medicare Part B effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "medicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "householdIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "annualIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyAmount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "existingCoverage": { "type": [ "string", "null" ], "enum": [ "None", "Medicare Advantage", "Original Medicare", "Medicaid", "Employer", "Marketplace/ACA", "Other", null ] }, "existingCoveragePlanName": { "type": [ "string", "null" ], "maxLength": 255 }, "existingCoverageCarrier": { "type": [ "string", "null" ], "maxLength": 255 }, "desiredCoverageStartDate": { "anyOf": [ { "anyOf": [ { "description": "Desired coverage start date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "currentSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "originalSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "agentName": { "type": [ "string", "null" ], "maxLength": 255 }, "agentNpn": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "memberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "enrollmentDate": { "anyOf": [ { "anyOf": [ { "description": "Customer enrollment date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "effectiveDate": { "anyOf": [ { "anyOf": [ { "description": "Customer coverage effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": "string" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "carrierAssignedCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "lastContactedAt": { "description": "Customer last contact time. ISO 8601 timestamp", "anyOf": [ { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "convertedAt": { "description": "Customer conversion time. ISO 8601 timestamp", "anyOf": [ { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "string", "const": "" } ] }, { "type": "null" } ] }, "testCustomer": { "type": "boolean" }, "phoneNumber": { "description": "Customer phone number. Accepts common formats and is normalized to E.164 (e.g. +14155550123); must be unique within your organization.", "type": "string", "minLength": 1 } }, "required": [ "phoneNumber" ] }, "GetV2InquiriesIdParameterId": { "description": "Inquiry ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2InquiriesIdPositiveResponse": { "description": "Full inquiry with related customer and call data", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Inquiry creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Inquiry last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "toolCallId": { "type": [ "string", "null" ] }, "duplicateOfId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inquiry": { "type": "string" }, "response": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "new", "pending_resolution", "unresolved", "resolved", "appointment_scheduled", "duplicate" ] }, "primaryCategory": { "type": [ "string", "null" ], "maxLength": 50 }, "subcategory": { "type": [ "string", "null" ], "maxLength": 100 }, "severity": { "type": [ "string", "null" ], "maxLength": 20 }, "severityTriggers": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "priority": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "priorityRationale": { "type": [ "string", "null" ] }, "priorityCategory": { "type": [ "string", "null" ], "maxLength": 120 }, "priorityConfidence": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "priorityRank": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "suggestedHandling": { "type": [ "string", "null" ], "maxLength": 50 }, "handlingRationale": { "type": [ "string", "null" ] }, "reasoning": { "type": [ "string", "null" ] }, "escalationApplied": { "type": [ "boolean", "null" ] }, "additionalConcerns": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "resolutionType": { "type": [ "string", "null" ], "maxLength": 20 }, "notes": { "type": [ "string", "null" ] }, "resolvedAt": { "description": "Inquiry resolution time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "resolvedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignedTo": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callbackRequestedAt": { "description": "Callback request time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "callbackRequestedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callbackWorkflowId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callbackCompletedAt": { "description": "Callback completion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "callbackCallId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callbackDisposition": { "type": [ "string", "null" ], "maxLength": 50 }, "callbackFailureReason": { "type": [ "string", "null" ], "maxLength": 100 }, "callbackScheduledFor": { "description": "Scheduled callback time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "carrierName": { "type": [ "string", "null" ] }, "planName": { "type": [ "string", "null" ] }, "planCode": { "type": [ "string", "null" ] }, "agentName": { "type": [ "string", "null" ] }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "callerId": { "type": [ "string", "null" ] }, "assignedUser": { "description": "User the inquiry is assigned to", "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "image" ], "additionalProperties": false }, "customerAssignedUser": { "description": "User the customer is assigned to", "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "image" ], "additionalProperties": false }, "customer": { "description": "Customer data associated with the inquiry", "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "state": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "enrollmentDate": { "description": "Customer enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Customer coverage effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "veteran": { "type": [ "boolean", "null" ] }, "medicareCard": { "type": [ "string", "null" ] }, "medicaid": { "type": [ "string", "null" ] }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "existingCoverage": { "type": [ "string", "null" ] }, "desiredCoverageStart": { "description": "Desired coverage start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "subsidyAmount": { "type": [ "number", "null" ] }, "householdIncome": { "type": [ "number", "null" ] }, "filingStatus": { "type": [ "string", "null" ] }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] } }, "required": [ "id", "email", "dateOfBirth", "state", "city", "postalCode", "address", "language", "timezone", "enrollmentDate", "effectiveDate", "veteran", "medicareCard", "medicaid", "socialSecurityDisability", "existingCoverage", "desiredCoverageStart", "subsidyAmount", "householdIncome", "filingStatus", "doNotCall", "doNotSMS", "doNotEmail", "doNotMail" ], "additionalProperties": false }, "call": { "description": "Call data associated with the inquiry", "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "callerId": { "type": [ "string", "null" ] }, "createdAt": { "description": "Call creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "disposition": { "type": [ "string", "null" ] }, "durationMs": { "type": [ "number", "null" ] }, "assistantType": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "transcript": { "type": [ "string", "null" ] }, "direction": { "type": [ "string", "null" ] }, "cost": { "type": [ "number", "null" ] }, "successEvaluation": { "type": [ "string", "null" ] }, "endedReason": { "type": [ "string", "null" ] }, "testFlag": { "type": [ "boolean", "null" ] } }, "required": [ "id", "callerId", "createdAt", "disposition", "durationMs", "assistantType", "summary", "transcript", "direction", "cost", "successEvaluation", "endedReason", "testFlag" ], "additionalProperties": false } }, "required": [ "id", "createdAt", "updatedAt", "customerCampaignId", "callId", "toolCallId", "duplicateOfId", "inquiry", "response", "status", "primaryCategory", "subcategory", "severity", "severityTriggers", "priority", "priorityRationale", "priorityCategory", "priorityConfidence", "priorityRank", "suggestedHandling", "handlingRationale", "reasoning", "escalationApplied", "additionalConcerns", "resolutionType", "notes", "resolvedAt", "resolvedBy", "assignedTo", "callbackRequestedAt", "callbackRequestedBy", "callbackWorkflowId", "callbackCompletedAt", "callbackCallId", "callbackDisposition", "callbackFailureReason", "callbackScheduledFor", "carrierName", "planName", "planCode", "agentName", "firstName", "lastName", "callerId", "assignedUser", "customerAssignedUser", "customer", "call" ], "additionalProperties": false }, "GetV2InquiriesIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2InquiriesIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2InquiriesIdParameterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2InquiriesIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Inquiry creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Inquiry last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "customerCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "toolCallId": { "type": [ "string", "null" ] }, "duplicateOfId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inquiry": { "type": "string" }, "response": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "new", "pending_resolution", "unresolved", "resolved", "appointment_scheduled", "duplicate" ] }, "primaryCategory": { "type": [ "string", "null" ], "maxLength": 50 }, "subcategory": { "type": [ "string", "null" ], "maxLength": 100 }, "severity": { "type": [ "string", "null" ], "maxLength": 20 }, "severityTriggers": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "priority": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "priorityRationale": { "type": [ "string", "null" ] }, "priorityCategory": { "type": [ "string", "null" ], "maxLength": 120 }, "priorityConfidence": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "priorityRank": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "suggestedHandling": { "type": [ "string", "null" ], "maxLength": 50 }, "handlingRationale": { "type": [ "string", "null" ] }, "reasoning": { "type": [ "string", "null" ] }, "escalationApplied": { "type": [ "boolean", "null" ] }, "additionalConcerns": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "resolutionType": { "type": [ "string", "null" ], "maxLength": 20 }, "notes": { "type": [ "string", "null" ] }, "resolvedAt": { "description": "Inquiry resolution time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "resolvedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignedTo": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callbackRequestedAt": { "description": "Callback request time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "callbackRequestedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callbackWorkflowId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callbackCompletedAt": { "description": "Callback completion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "callbackCallId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "callbackDisposition": { "type": [ "string", "null" ], "maxLength": 50 }, "callbackFailureReason": { "type": [ "string", "null" ], "maxLength": 100 }, "callbackScheduledFor": { "description": "Scheduled callback time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "createdAt", "updatedAt", "customerCampaignId", "callId", "toolCallId", "duplicateOfId", "inquiry", "response", "status", "primaryCategory", "subcategory", "severity", "severityTriggers", "priority", "priorityRationale", "priorityCategory", "priorityConfidence", "priorityRank", "suggestedHandling", "handlingRationale", "reasoning", "escalationApplied", "additionalConcerns", "resolutionType", "notes", "resolvedAt", "resolvedBy", "assignedTo", "callbackRequestedAt", "callbackRequestedBy", "callbackWorkflowId", "callbackCompletedAt", "callbackCallId", "callbackDisposition", "callbackFailureReason", "callbackScheduledFor" ], "additionalProperties": false }, "PatchV2InquiriesIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2InquiriesIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2InquiriesIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2InquiriesIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2InquiriesIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2InquiriesIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2InquiriesIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2InquiriesIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2InquiriesIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2InquiriesIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2InquiriesIdRequestBody": { "type": "object", "properties": { "resolutionType": { "type": [ "string", "null" ], "maxLength": 20 }, "response": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "new", "pending_resolution", "unresolved", "resolved", "appointment_scheduled", "duplicate" ] }, "notes": { "type": [ "string", "null" ] } } }, "GetV2InquiriesParameterPage": { "default": 1, "type": "number", "minimum": 1 }, "GetV2InquiriesParameterPerPage": { "default": 50, "type": "number", "minimum": 1, "maximum": 100 }, "GetV2InquiriesParameterStatus": { "description": "Filter inquiries by status. Single value or comma-separated list (e.g. 'new' or 'new,pending_resolution,unresolved')", "type": "string" }, "GetV2InquiriesParameterAgentName": { "description": "Filter inquiries by agent name", "type": "string" }, "GetV2InquiriesParameterAssignedTo": { "description": "Filter inquiries by assigned user. Single user id or comma-separated list of user ids.", "type": "string" }, "GetV2InquiriesParameterPriority": { "description": "Filter to one priority tier, or 'none' for unscored inquiries", "type": "string", "enum": [ "1", "2", "3", "4", "5", "none" ] }, "GetV2InquiriesParameterCustomerId": { "description": "Filter inquiries to a single customer", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2InquiriesParameterSearch": { "description": "Search inquiries by customer name or phone number", "type": "string" }, "GetV2InquiriesParameterSortBy": { "description": "Column to sort by. Supported: 'createdAt' (default), 'priority'. Unknown values fall back to createdAt.", "type": "string" }, "GetV2InquiriesParameterSortDirection": { "description": "Sort direction, defaults to desc. For 'priority', direction describes urgency: desc = most urgent (P1) first.", "type": "string", "enum": [ "asc", "desc" ] }, "GetV2InquiriesPositiveResponse": { "type": "object", "properties": { "itemsTotal": { "type": "number" }, "currentPage": { "type": "number" }, "nextPage": { "type": [ "number", "null" ] }, "prevPage": { "type": [ "number", "null" ] }, "items": { "description": "List of inquiries", "type": "array", "items": { "description": "Simplified inquiry for list view", "type": "object", "properties": { "id": { "type": "string" }, "customerCampaignId": { "type": "string" }, "callId": { "type": [ "string", "null" ] }, "duplicateOfId": { "type": [ "string", "null" ] }, "inquiry": { "type": "string" }, "status": { "type": "string" }, "primaryCategory": { "type": [ "string", "null" ] }, "severity": { "type": [ "string", "null" ] }, "priority": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "priorityRationale": { "type": [ "string", "null" ] }, "priorityCategory": { "type": [ "string", "null" ] }, "priorityConfidence": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "resolvedAt": { "description": "Inquiry resolution time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "description": "Inquiry creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "response": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "resolutionType": { "type": [ "string", "null" ] }, "callbackRequestedAt": { "description": "Callback request time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "callbackScheduledFor": { "description": "Scheduled callback time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "callbackCompletedAt": { "description": "Callback completion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "callbackDisposition": { "type": [ "string", "null" ] }, "callbackFailureReason": { "type": [ "string", "null" ] }, "customerId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerName": { "type": [ "string", "null" ] }, "callerId": { "type": [ "string", "null" ] }, "customerTimezone": { "type": [ "string", "null" ] }, "customerPostalCode": { "type": [ "string", "null" ] }, "agentName": { "type": [ "string", "null" ] }, "carrierName": { "type": [ "string", "null" ] }, "planName": { "type": [ "string", "null" ] }, "campaign": { "description": "Campaign data associated with the inquiry", "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "templateId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string" }, "createdAt": { "description": "Campaign creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "description": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "templateId", "status", "createdAt", "description" ], "additionalProperties": false }, "assignedUser": { "description": "User the inquiry is assigned to", "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "image" ], "additionalProperties": false }, "customerAssignedUser": { "description": "User the customer is assigned to", "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "image" ], "additionalProperties": false } }, "required": [ "id", "customerCampaignId", "callId", "duplicateOfId", "inquiry", "status", "primaryCategory", "severity", "priority", "priorityRationale", "priorityCategory", "priorityConfidence", "resolvedAt", "createdAt", "response", "notes", "resolutionType", "callbackRequestedAt", "callbackScheduledFor", "callbackCompletedAt", "callbackDisposition", "callbackFailureReason", "customerId", "customerName", "callerId", "customerTimezone", "customerPostalCode", "agentName", "carrierName", "planName", "campaign", "assignedUser", "customerAssignedUser" ], "additionalProperties": false } } }, "required": [ "itemsTotal", "currentPage", "nextPage", "prevPage", "items" ], "additionalProperties": false }, "GetV2InquiriesNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2InquiriesNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2InquiriesNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPerformanceParameterCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2SourcesPerformanceParameterStartDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "GetV2SourcesPerformanceParameterEndDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "GetV2SourcesPerformancePositiveResponse": { "type": "object", "properties": { "sources": { "type": "array", "items": { "type": "object", "properties": { "sourceId": { "type": "string" }, "campaignSourceId": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "pings_total": { "description": "Vendor availability pings received for this source", "type": "number" }, "pings_available": { "description": "Pings answered available (yes, send the caller)", "type": "number" }, "pings_dialed": { "description": "Available pings where the caller actually arrived (dialed)", "type": "number" }, "pings_billable": { "description": "Dialed pings whose matched call produced a billable event", "type": "number" }, "pings_converted": { "description": "Dialed pings whose caller later converted (policy created or conversion recorded). Cohort attribution: the conversion counts toward the ping that produced the caller regardless of when it occurred.", "type": "number" }, "ping_to_call_rate": { "description": "pings_dialed / pings_available, percent", "type": "number" }, "ping_billable_rate": { "description": "pings_billable / pings_dialed, percent", "type": "number" }, "ping_conversion_rate": { "description": "pings_converted / pings_dialed, percent", "type": "number" }, "leads_dialed": { "type": "number" }, "contact_rate": { "type": "number" }, "transfer_rate": { "type": "number" }, "appointments_booked": { "type": "number" }, "appointment_rate": { "type": "number" }, "close_rate": { "type": "number" }, "external_transfers": { "type": "number" }, "pending_outcomes": { "type": "number" }, "pending_outcome_rate": { "type": "number" }, "total_usage_cost": { "type": "number" }, "total_cost": { "type": "number" }, "cost_per_transfer": { "type": "number" }, "total_calls": { "type": "number" }, "billable_calls": { "type": "number" }, "billable_percentage": { "type": "number" }, "spend": { "type": "number" }, "new_transfers": { "type": "number" }, "new_calls": { "type": "number" }, "new_transfer_percentage": { "type": "number" }, "appointment_transfers": { "type": "number" }, "appointment_calls": { "type": "number" }, "appointment_transfer_percentage": { "type": "number" }, "total_transfers": { "type": "number" }, "total_transfer_percentage": { "type": "number" }, "billable_transfers": { "type": "number" }, "billable_transfer_rate": { "type": "number" }, "converted_calls": { "type": "number" }, "transfer_conversion_rate": { "type": "number" }, "cost_per_acquisition": { "type": "number" }, "average_cpa": { "type": "number" } }, "required": [ "sourceId", "name" ], "additionalProperties": false } }, "agentBreakdown": { "type": "array", "items": { "type": "object", "properties": { "sourceId": { "type": "string" }, "campaignSourceId": { "type": "string" }, "sourceName": { "type": [ "string", "null" ] }, "agentId": { "type": "string" }, "agentName": { "type": [ "string", "null" ] }, "total_calls": { "type": "number" }, "transfers": { "type": "number" }, "transfer_rate": { "type": "number" }, "external_transfers": { "type": "number" }, "appointments_booked": { "type": "number" }, "appointment_rate": { "type": "number" }, "converted_calls": { "type": "number" }, "close_rate": { "type": "number" }, "pending_outcomes": { "type": "number" }, "pending_outcome_rate": { "type": "number" }, "billable_calls": { "type": "number" }, "spend": { "type": "number" }, "total_usage_cost": { "type": "number" }, "total_cost": { "type": "number" }, "cost_per_transfer": { "type": "number" }, "cost_per_acquisition": { "type": "number" }, "average_cpa": { "type": "number" } }, "required": [ "sourceId", "campaignSourceId", "sourceName", "agentId", "agentName", "total_calls", "transfers", "transfer_rate", "external_transfers", "appointments_booked", "appointment_rate", "converted_calls", "close_rate", "pending_outcomes", "pending_outcome_rate", "billable_calls", "spend", "total_usage_cost", "total_cost", "cost_per_transfer", "cost_per_acquisition", "average_cpa" ], "additionalProperties": false } }, "dispositionBreakdown": { "type": "array", "items": { "type": "object", "properties": { "sourceId": { "type": "string" }, "campaignSourceId": { "type": "string" }, "sourceName": { "type": [ "string", "null" ] }, "disposition": { "type": "string" }, "count": { "type": "number" }, "percentage": { "type": "number" } }, "required": [ "sourceId", "campaignSourceId", "sourceName", "disposition", "count", "percentage" ], "additionalProperties": false } }, "stateBreakdown": { "type": "array", "items": { "type": "object", "properties": { "sourceId": { "type": "string" }, "campaignSourceId": { "type": "string" }, "sourceName": { "type": [ "string", "null" ] }, "state": { "type": "string" }, "leads_dialed": { "type": "number" }, "contact_rate": { "type": "number" }, "transfer_rate": { "type": "number" }, "appointments_booked": { "type": "number" }, "converted_calls": { "type": "number" }, "pending_outcomes": { "type": "number" } }, "required": [ "state", "leads_dialed", "contact_rate", "transfer_rate" ], "additionalProperties": false } } }, "required": [ "sources", "agentBreakdown", "dispositionBreakdown", "stateBreakdown" ], "additionalProperties": false }, "GetV2SourcesPerformanceNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPerformanceNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPerformanceNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPerformanceNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2SourcesPerformanceNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPerformanceNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPerformanceNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPerformanceNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPerformanceNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPerformanceNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPingsParameterPage": { "default": 1, "type": "number", "minimum": 1 }, "GetV2SourcesPingsParameterPerPage": { "default": 50, "type": "number", "minimum": 1, "maximum": 100 }, "GetV2SourcesPingsParameterSourceId": { "description": "Source filter: accepts the public source ID or the internal source UUID. Unknown values return an empty result rather than an error.", "type": "string", "maxLength": 255 }, "GetV2SourcesPingsParameterCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2SourcesPingsParameterStartDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "GetV2SourcesPingsParameterEndDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "GetV2SourcesPingsParameterAvailability": { "description": "Filter by the availability answered to the vendor", "type": "string", "enum": [ "available", "unavailable" ] }, "GetV2SourcesPingsParameterStatus": { "type": "string", "enum": [ "pending", "dialed", "expired", "unavailable", "revoked" ] }, "GetV2SourcesPingsPositiveResponse": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "total": { "type": "number" }, "available": { "type": "number" }, "unavailable": { "type": "number" }, "dialed": { "description": "Pings where the caller actually arrived", "type": "number" }, "billable": { "description": "Dialed pings whose matched call produced a billable event", "type": "number" }, "converted": { "description": "Dialed pings whose caller later converted (policy created or conversion recorded), cohort-attributed regardless of when the conversion occurred", "type": "number" }, "acceptRate": { "description": "available / total, percent", "type": "number" }, "pingToCallRate": { "description": "dialed / available, percent", "type": "number" }, "billableRate": { "description": "billable / dialed, percent", "type": "number" }, "conversionRate": { "description": "converted / dialed, percent", "type": "number" }, "uniqueCallers": { "type": "number" }, "lastPingAt": { "description": "Most recent ping time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "fieldCoverage": { "type": "object", "properties": { "state": { "type": "number" }, "postalCode": { "type": "number" }, "dateOfBirth": { "type": "number" }, "name": { "type": "number" } }, "required": [ "state", "postalCode", "dateOfBirth", "name" ], "additionalProperties": false } }, "required": [ "total", "available", "unavailable", "dialed", "billable", "converted", "acceptRate", "pingToCallRate", "billableRate", "conversionRate", "uniqueCallers", "lastPingAt", "fieldCoverage" ], "additionalProperties": false }, "timeseries": { "type": "object", "properties": { "granularity": { "description": "hour for windows up to 3 days, day beyond", "type": "string", "enum": [ "hour", "day" ] }, "buckets": { "type": "array", "items": { "type": "object", "properties": { "bucketStart": { "description": "UTC bucket start. ISO 8601 timestamp", "type": "string", "format": "date-time" }, "total": { "type": "number" }, "available": { "type": "number" }, "unavailable": { "type": "number" }, "dialed": { "type": "number" } }, "required": [ "bucketStart", "total", "available", "unavailable", "dialed" ], "additionalProperties": false } } }, "required": [ "granularity", "buckets" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Ping creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "sourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "publicSourceId": { "type": [ "string", "null" ] }, "sourceName": { "type": [ "string", "null" ] }, "campaignSourceId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignName": { "type": [ "string", "null" ] }, "callerId": { "type": "string" }, "subId": { "type": [ "string", "null" ] }, "agentAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "pending", "dialed", "expired", "unavailable", "revoked" ] }, "unavailableReason": { "type": [ "string", "null" ] }, "revocationReason": { "type": [ "string", "null" ] }, "revokedAt": { "description": "Offer revocation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "returnedNumber": { "type": [ "string", "null" ] }, "consentBasis": { "type": [ "string", "null" ] }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "piiPurged": { "type": "boolean" }, "dialedAt": { "description": "Caller arrival time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "billable": { "type": "boolean" }, "converted": { "type": "boolean" }, "callHistoryId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expiresAt": { "description": "Ping expiration time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "createdAt", "sourceId", "publicSourceId", "sourceName", "campaignSourceId", "campaignId", "campaignName", "callerId", "subId", "agentAvailable", "status", "unavailableReason", "revocationReason", "revokedAt", "returnedNumber", "consentBasis", "firstName", "lastName", "state", "postalCode", "piiPurged", "dialedAt", "billable", "converted", "callHistoryId", "expiresAt" ], "additionalProperties": false } }, "itemsTotal": { "type": "number" }, "currentPage": { "type": "number" }, "nextPage": { "type": [ "number", "null" ] }, "prevPage": { "type": [ "number", "null" ] } }, "required": [ "summary", "timeseries", "items", "itemsTotal", "currentPage", "nextPage", "prevPage" ], "additionalProperties": false }, "GetV2SourcesPingsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPingsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPingsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPingsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2SourcesPingsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPingsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPingsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPingsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPingsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesPingsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsParameterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2SourcesIdAssignmentsPositiveResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignName": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "enabled": { "type": "boolean" }, "phoneNumberId": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "phoneNumber": { "type": [ "string", "null" ] }, "service": { "type": [ "string", "null" ], "enum": [ "mobius", "softphone", null ] }, "assignedAt": { "description": "Source assignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "unassignedAt": { "description": "Source unassignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "id", "sourceId", "campaignId", "direction", "enabled", "phoneNumberId", "assignedAt", "unassignedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdAssignmentsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsParameterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PostV2SourcesIdAssignmentsPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignName": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "enabled": { "type": "boolean" }, "phoneNumberId": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "phoneNumber": { "type": [ "string", "null" ] }, "service": { "type": [ "string", "null" ], "enum": [ "mobius", "softphone", null ] }, "assignedAt": { "description": "Source assignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "unassignedAt": { "description": "Source unassignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "id", "sourceId", "campaignId", "direction", "enabled", "phoneNumberId", "assignedAt", "unassignedAt" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesIdAssignmentsRequestBody": { "type": "object", "properties": { "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceType": { "description": "Acquisition type: outbound for lead records, inbound for live calls. Independent of campaign direction.", "type": "string", "enum": [ "outbound", "inbound" ] }, "phoneNumberId": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "enabled": { "type": "boolean" }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "campaignId" ], "additionalProperties": false }, "GetV2SourcesIdParameterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2SourcesIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "channel": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "archived" ] }, "dealType": { "type": "string", "enum": [ "CPA", "CPL" ] }, "pricingModel": { "type": "string", "enum": [ "flat_rate", "percentage", "dynamic", "static", "duration" ] }, "payout": { "type": [ "string", "null" ] }, "commissionPerSale": { "type": [ "string", "null" ] }, "leadCost": { "type": [ "string", "null" ] }, "durationThreshold": { "type": [ "string", "null" ] }, "externalRefs": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "description": "Source creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Source last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignName": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "enabled": { "type": "boolean" }, "phoneNumberId": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "phoneNumber": { "type": [ "string", "null" ] }, "service": { "type": [ "string", "null" ], "enum": [ "mobius", "softphone", null ] }, "assignedAt": { "description": "Source assignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "unassignedAt": { "description": "Source unassignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "sourceId", "campaignId", "direction", "enabled", "phoneNumberId", "assignedAt", "unassignedAt" ], "additionalProperties": false } }, "assignmentCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "leadDestinationCampaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "leadDestinationCampaignName": { "type": [ "string", "null" ] } }, "required": [ "id", "sourceId", "clientId", "name", "description", "status", "dealType", "pricingModel", "payout", "commissionPerSale", "leadCost", "durationThreshold", "createdAt", "updatedAt", "assignments", "assignmentCount" ], "additionalProperties": false }, "GetV2SourcesIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2SourcesIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourcesIdParameterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2SourcesIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "channel": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "archived" ] }, "dealType": { "type": "string", "enum": [ "CPA", "CPL" ] }, "pricingModel": { "type": "string", "enum": [ "flat_rate", "percentage", "dynamic", "static", "duration" ] }, "payout": { "type": [ "string", "null" ] }, "commissionPerSale": { "type": [ "string", "null" ] }, "leadCost": { "type": [ "string", "null" ] }, "durationThreshold": { "type": [ "string", "null" ] }, "externalRefs": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "description": "Source creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Source last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignName": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "enabled": { "type": "boolean" }, "phoneNumberId": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "phoneNumber": { "type": [ "string", "null" ] }, "service": { "type": [ "string", "null" ], "enum": [ "mobius", "softphone", null ] }, "assignedAt": { "description": "Source assignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "unassignedAt": { "description": "Source unassignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "sourceId", "campaignId", "direction", "enabled", "phoneNumberId", "assignedAt", "unassignedAt" ], "additionalProperties": false } }, "assignmentCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "leadDestinationCampaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "leadDestinationCampaignName": { "type": [ "string", "null" ] } }, "required": [ "id", "sourceId", "clientId", "name", "description", "status", "dealType", "pricingModel", "payout", "commissionPerSale", "leadCost", "durationThreshold", "createdAt", "updatedAt", "assignments", "assignmentCount" ], "additionalProperties": false }, "PatchV2SourcesIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourcesIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourcesIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourcesIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2SourcesIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourcesIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourcesIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourcesIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourcesIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourcesIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourcesIdRequestBody": { "type": "object", "properties": { "sourceId": { "type": "string", "maxLength": 255 }, "name": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "label": { "type": [ "string", "null" ], "maxLength": 255 }, "type": { "type": [ "string", "null" ], "maxLength": 100 }, "channel": { "type": [ "string", "null" ], "maxLength": 100 }, "status": { "type": "string", "enum": [ "active", "inactive", "archived" ] }, "dealType": { "type": "string", "enum": [ "CPA", "CPL" ] }, "pricingModel": { "type": "string", "enum": [ "flat_rate", "percentage", "dynamic", "static", "duration" ] }, "payout": { "type": "string" }, "commissionPerSale": { "type": "string" }, "leadCost": { "type": "string" }, "durationThreshold": { "type": "string" }, "externalRefs": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [], "additionalProperties": false }, "DeleteV2SourcesIdParameterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2SourcesIdPositiveResponse": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SourcesIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SourcesIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SourcesIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SourcesIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2SourcesIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SourcesIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SourcesIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SourcesIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SourcesIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SourcesIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesParameterPage": { "default": 1, "type": "number", "minimum": 1 }, "GetV2SourcesParameterPerPage": { "default": 50, "type": "number", "minimum": 1, "maximum": 100 }, "GetV2SourcesParameterSearch": { "type": "string" }, "GetV2SourcesParameterEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "GetV2SourcesParameterDealType": { "type": "string", "enum": [ "CPA", "CPL" ] }, "GetV2SourcesParameterCampaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2SourcesParameterDirection": { "type": "string", "enum": [ "outbound", "inbound" ] }, "GetV2SourcesPositiveResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "channel": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "archived" ] }, "dealType": { "type": "string", "enum": [ "CPA", "CPL" ] }, "pricingModel": { "type": "string", "enum": [ "flat_rate", "percentage", "dynamic", "static", "duration" ] }, "payout": { "type": [ "string", "null" ] }, "commissionPerSale": { "type": [ "string", "null" ] }, "leadCost": { "type": [ "string", "null" ] }, "durationThreshold": { "type": [ "string", "null" ] }, "externalRefs": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "description": "Source creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Source last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignName": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "enabled": { "type": "boolean" }, "phoneNumberId": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "phoneNumber": { "type": [ "string", "null" ] }, "service": { "type": [ "string", "null" ], "enum": [ "mobius", "softphone", null ] }, "assignedAt": { "description": "Source assignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "unassignedAt": { "description": "Source unassignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "sourceId", "campaignId", "direction", "enabled", "phoneNumberId", "assignedAt", "unassignedAt" ], "additionalProperties": false } }, "assignmentCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "leadDestinationCampaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "leadDestinationCampaignName": { "type": [ "string", "null" ] } }, "required": [ "id", "sourceId", "clientId", "name", "description", "status", "dealType", "pricingModel", "payout", "commissionPerSale", "leadCost", "durationThreshold", "createdAt", "updatedAt", "assignments", "assignmentCount" ], "additionalProperties": false } }, "itemsTotal": { "type": "number" }, "currentPage": { "type": "number" }, "nextPage": { "type": [ "number", "null" ] }, "prevPage": { "type": [ "number", "null" ] } }, "required": [ "items", "itemsTotal", "currentPage", "nextPage", "prevPage" ], "additionalProperties": false }, "GetV2SourcesNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2SourcesNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SourcesNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "channel": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "archived" ] }, "dealType": { "type": "string", "enum": [ "CPA", "CPL" ] }, "pricingModel": { "type": "string", "enum": [ "flat_rate", "percentage", "dynamic", "static", "duration" ] }, "payout": { "type": [ "string", "null" ] }, "commissionPerSale": { "type": [ "string", "null" ] }, "leadCost": { "type": [ "string", "null" ] }, "durationThreshold": { "type": [ "string", "null" ] }, "externalRefs": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "description": "Source creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Source last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignName": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "enabled": { "type": "boolean" }, "phoneNumberId": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "phoneNumber": { "type": [ "string", "null" ] }, "service": { "type": [ "string", "null" ], "enum": [ "mobius", "softphone", null ] }, "assignedAt": { "description": "Source assignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "unassignedAt": { "description": "Source unassignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "sourceId", "campaignId", "direction", "enabled", "phoneNumberId", "assignedAt", "unassignedAt" ], "additionalProperties": false } }, "assignmentCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "leadDestinationCampaignId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "leadDestinationCampaignName": { "type": [ "string", "null" ] }, "pingPostApiKey": { "type": [ "string", "null" ] } }, "required": [ "id", "sourceId", "clientId", "name", "description", "status", "dealType", "pricingModel", "payout", "commissionPerSale", "leadCost", "durationThreshold", "createdAt", "updatedAt", "assignments", "assignmentCount", "pingPostApiKey" ], "additionalProperties": false }, "PostV2SourcesNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2SourcesNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SourcesRequestBody": { "type": "object", "properties": { "createPingPostKey": { "description": "Explicitly issue a vendor ping-post key for a live-call integration", "default": false, "type": "boolean" }, "sourceId": { "type": "string", "maxLength": 255 }, "name": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "label": { "type": "string", "maxLength": 255 }, "type": { "type": "string", "maxLength": 100 }, "channel": { "type": "string", "maxLength": 100 }, "status": { "type": "string", "enum": [ "active", "inactive", "archived" ] }, "dealType": { "type": "string", "enum": [ "CPA", "CPL" ] }, "pricingModel": { "type": "string", "enum": [ "flat_rate", "percentage", "dynamic", "static", "duration" ] }, "payout": { "type": "string" }, "commissionPerSale": { "type": "string" }, "leadCost": { "type": "string" }, "durationThreshold": { "type": "string" }, "assignment": { "type": [ "object", "null" ], "properties": { "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceType": { "description": "Acquisition type: outbound for lead records, inbound for live calls. Independent of campaign direction.", "type": "string", "enum": [ "outbound", "inbound" ] }, "phoneNumberId": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "enabled": { "type": "boolean" }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "campaignId" ], "additionalProperties": false }, "externalRefs": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "metadata": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "dealType", "pricingModel" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdParameterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PatchV2SourceAssignmentsIdPositiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "campaignName": { "type": [ "string", "null" ] }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "enabled": { "type": "boolean" }, "phoneNumberId": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "phoneNumber": { "type": [ "string", "null" ] }, "service": { "type": [ "string", "null" ], "enum": [ "mobius", "softphone", null ] }, "assignedAt": { "description": "Source assignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "unassignedAt": { "description": "Source unassignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "id", "sourceId", "campaignId", "direction", "enabled", "phoneNumberId", "assignedAt", "unassignedAt" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PatchV2SourceAssignmentsIdRequestBody": { "type": "object", "properties": { "sourceType": { "type": "string", "enum": [ "outbound", "inbound" ] }, "phoneNumberId": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "enabled": { "type": "boolean" }, "unassignedAt": { "description": "Source unassignment time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "metadata": { "type": [ "object", "null" ], "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [], "additionalProperties": false }, "GetV2CustomFieldsIdParameterId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2CustomFieldsIdPositiveResponse": { "description": "Custom field definition with all metadata", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Custom field definition creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Custom field definition last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordType": { "type": "string", "enum": [ "customers", "policies" ] }, "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "deleted": { "type": "boolean" }, "deletedAt": { "description": "Custom field definition deletion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "recordType", "fieldKey", "fieldLabel", "fieldDescription", "fieldType", "isRequired", "options", "validationRules", "deleted", "deletedAt" ], "additionalProperties": false }, "GetV2CustomFieldsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CustomFieldsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CustomFieldsIdParameterId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "PutV2CustomFieldsIdPositiveResponse": { "description": "Custom field definition with all metadata", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Custom field definition creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Custom field definition last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordType": { "type": "string", "enum": [ "customers", "policies" ] }, "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "deleted": { "type": "boolean" }, "deletedAt": { "description": "Custom field definition deletion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "recordType", "fieldKey", "fieldLabel", "fieldDescription", "fieldType", "isRequired", "options", "validationRules", "deleted", "deletedAt" ], "additionalProperties": false }, "PutV2CustomFieldsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CustomFieldsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CustomFieldsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CustomFieldsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PutV2CustomFieldsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CustomFieldsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CustomFieldsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CustomFieldsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CustomFieldsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CustomFieldsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PutV2CustomFieldsIdRequestBody": { "type": "object", "properties": { "recordType": { "type": "string", "enum": [ "customers", "policies" ] }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "type": "object", "properties": { "min": { "type": "number" }, "max": { "type": "number" }, "pattern": { "type": "string" }, "maxLength": { "type": "number" }, "minDate": { "description": "Earliest allowed calendar date. Format: YYYY-MM-DD", "type": "string", "format": "date" }, "maxDate": { "description": "Latest allowed calendar date. Format: YYYY-MM-DD", "type": "string", "format": "date" }, "maxSelections": { "type": "number" } } } }, "required": [] }, "DeleteV2CustomFieldsIdParameterId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "DeleteV2CustomFieldsIdPositiveResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "success", "message" ], "additionalProperties": false }, "DeleteV2CustomFieldsIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomFieldsIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomFieldsIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomFieldsIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2CustomFieldsIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomFieldsIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomFieldsIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomFieldsIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomFieldsIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2CustomFieldsIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsParameterPage": { "default": 1, "type": "number", "minimum": 1 }, "GetV2CustomFieldsParameterPerPage": { "default": 50, "type": "number", "minimum": 1, "maximum": 100 }, "GetV2CustomFieldsParameterRecordType": { "description": "Filter by record type", "type": "string", "enum": [ "customers", "policies" ] }, "GetV2CustomFieldsParameterSortBy": { "description": "Field to sort by", "default": "createdAt", "type": "string", "enum": [ "createdAt", "fieldLabel", "fieldType" ] }, "GetV2CustomFieldsParameterSortDirection": { "description": "Sort direction", "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "GetV2CustomFieldsPositiveResponse": { "type": "object", "properties": { "itemsTotal": { "type": "number" }, "currentPage": { "type": "number" }, "nextPage": { "type": [ "number", "null" ] }, "prevPage": { "type": [ "number", "null" ] }, "items": { "description": "List of custom field definitions", "type": "array", "items": { "description": "Custom field definition with all metadata", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Custom field definition creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Custom field definition last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordType": { "type": "string", "enum": [ "customers", "policies" ] }, "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "deleted": { "type": "boolean" }, "deletedAt": { "description": "Custom field definition deletion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "recordType", "fieldKey", "fieldLabel", "fieldDescription", "fieldType", "isRequired", "options", "validationRules", "deleted", "deletedAt" ], "additionalProperties": false } } }, "required": [ "itemsTotal", "currentPage", "nextPage", "prevPage", "items" ], "additionalProperties": false }, "GetV2CustomFieldsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2CustomFieldsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2CustomFieldsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomFieldsPositiveResponse": { "description": "Custom field definition with all metadata", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Custom field definition creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Custom field definition last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "recordType": { "type": "string", "enum": [ "customers", "policies" ] }, "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "deleted": { "type": "boolean" }, "deletedAt": { "description": "Custom field definition deletion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "createdAt", "updatedAt", "clientId", "recordType", "fieldKey", "fieldLabel", "fieldDescription", "fieldType", "isRequired", "options", "validationRules", "deleted", "deletedAt" ], "additionalProperties": false }, "PostV2CustomFieldsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomFieldsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomFieldsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomFieldsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2CustomFieldsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomFieldsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomFieldsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomFieldsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomFieldsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomFieldsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2CustomFieldsRequestBody": { "type": "object", "properties": { "recordType": { "type": "string", "enum": [ "customers", "policies" ] }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "type": "object", "properties": { "min": { "type": "number" }, "max": { "type": "number" }, "pattern": { "type": "string" }, "maxLength": { "type": "number" }, "minDate": { "description": "Earliest allowed calendar date. Format: YYYY-MM-DD", "type": "string", "format": "date" }, "maxDate": { "description": "Latest allowed calendar date. Format: YYYY-MM-DD", "type": "string", "format": "date" }, "maxSelections": { "type": "number" } } } }, "required": [ "recordType", "fieldLabel", "fieldDescription", "fieldType" ] }, "PostV2SyncAcaPositiveResponse": { "type": "object", "properties": { "succeeded": { "description": "Number of successfully synced records", "type": "number" }, "failed": { "description": "Number of failed records", "type": "number" }, "results": { "description": "The full customer record for each successfully synced row, each with the policies that this request changed", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "description": "Customer creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Customer last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "deletedAt": { "description": "Customer deletion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "externalId": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "firstName": { "type": [ "string", "null" ] }, "middleName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "salutation": { "type": [ "string", "null" ] }, "suffix": { "type": [ "string", "null" ] }, "preferredName": { "type": [ "string", "null" ] }, "phoneNumber": { "type": "string" }, "isPhonePrimary": { "type": "boolean" }, "lineType": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "language": { "type": [ "string", "null" ] }, "ethnicity": { "type": [ "string", "null" ] }, "gender": { "type": [ "string", "null" ] }, "maritalStatus": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "address2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "mbiNumber": { "type": [ "string", "null" ] }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "description": "Medicare Part A effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicarePartBDate": { "description": "Medicare Part B effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "hasMedicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ] }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "heightInches": { "type": [ "number", "null" ] }, "weightPounds": { "type": [ "number", "null" ] }, "smokerStatus": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ] }, "householdIncome": { "type": [ "number", "null" ] }, "annualIncome": { "type": [ "number", "null" ] }, "filingStatus": { "type": [ "string", "null" ] }, "dependentCount": { "type": [ "number", "null" ] }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "subsidyAmount": { "type": [ "number", "null" ] }, "carrierAssignedCustomerId": { "type": [ "string", "null" ] }, "agentName": { "type": [ "string", "null" ] }, "agentNpn": { "type": [ "number", "null" ] }, "assignedUser": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "npn": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "licensedStates": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "id", "name", "email", "npn", "role", "licensedStates" ], "additionalProperties": false }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "testCustomer": { "type": "boolean" }, "policies": { "description": "Policies changed by this request: those created or updated from the request, plus any older policies auto-terminated as a side effect. Does NOT include the customer's untouched existing policies.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Policy creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Policy last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "policyType": { "type": "string", "enum": [ "MA", "MAPD", "PDP", "MS", "ACA", "LTC", "Individual Health", "FE", "Annuity", "Life", "Dental", "Vision", "Hospital Indemnity", "Cancer", "Critical Illness", "Accident", "Group", "Home Health Care", "International Travel" ] }, "policySubType": { "type": [ "string", "null" ], "maxLength": 100 }, "policyNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "applicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierAssignedPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "sunFireEnrollmentCode": { "type": [ "string", "null" ], "maxLength": 255 }, "connectureConfirmationNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "hiosId": { "type": [ "string", "null" ], "maxLength": 255 }, "metalLevel": { "type": [ "string", "null" ], "enum": [ "Catastrophic", "Bronze", "Expanded Bronze", "Silver", "Gold", "Platinum", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", null ] }, "applicationApprovalDate": { "description": "Application approval date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Policy effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "terminationDate": { "description": "Policy termination date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "renewalDate": { "description": "Policy renewal date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "enrollmentDate": { "description": "Policy enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "cancelledDate": { "description": "Policy cancellation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "declineReason": { "type": [ "string", "null" ] }, "declineReasonDescription": { "type": [ "string", "null" ] }, "cancellationReason": { "type": [ "string", "null" ] }, "cancellationReasonDescription": { "type": [ "string", "null" ] }, "electionPeriod": { "type": [ "string", "null" ], "enum": [ "IEP", "AEP", "OEP", "SEP", "ICEP", "MA-OEP", null ] }, "gracePeriodStartDate": { "description": "Grace period start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "paidThroughDate": { "description": "Coverage paid-through date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "ffmApplicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "ffmSubscriberId": { "type": [ "string", "null" ], "maxLength": 255 }, "aorAgentId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "aorFirstName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorLastName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentName": { "type": [ "string", "null" ], "maxLength": 255 }, "sepType": { "type": [ "string", "null" ], "maxLength": 255 }, "sepCode": { "type": [ "string", "null" ], "maxLength": 100 }, "sepStartDate": { "description": "SEP start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepEndDate": { "description": "SEP end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepDocumentationReceived": { "type": [ "boolean", "null" ] }, "sepDocumentationDate": { "description": "SEP documentation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepNotes": { "type": [ "string", "null" ] }, "monthlyPremium": { "type": [ "string", "null" ] }, "deductible": { "type": [ "string", "null" ] }, "outOfPocketMax": { "type": [ "string", "null" ] }, "subsidyAmount": { "type": [ "string", "null" ] }, "usingSubsidy": { "type": [ "boolean", "null" ] }, "premiumMode": { "type": [ "string", "null" ], "enum": [ "Monthly", "Quarterly", "Semi-Annual", "Annual", null ] }, "paymentMode": { "type": [ "string", "null" ], "enum": [ "ACH", "Credit/ debit card", "Direct bill", null ] }, "paymentMethod": { "type": [ "string", "null" ], "enum": [ "Credit Card", "Debit Card", "Check", "ACH / Bank Draft", "Money Order", "Cash", "Other", null ] }, "grossPremium": { "type": [ "string", "null" ] }, "netPremium": { "type": [ "string", "null" ] }, "initialCommission": { "type": [ "string", "null" ] }, "renewalCommission": { "type": [ "string", "null" ] }, "spifAmount": { "type": [ "string", "null" ] }, "policyLives": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "wasAgent": { "type": [ "boolean", "null" ] }, "writtenAs": { "type": [ "string", "null" ], "enum": [ "New Business", "Like Plan Change", "Unlike Plan Change", "Reinstatement", "Rewrite", null ] }, "isReplacing": { "type": [ "string", "null" ], "maxLength": 255 }, "isRewrite": { "type": [ "boolean", "null" ] }, "hospitalNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "pcpNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "ssbciVerificationRequired": { "type": [ "boolean", "null" ] }, "dailyBenefit": { "type": [ "string", "null" ] }, "eliminationPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "benefitPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "hasCola": { "type": [ "boolean", "null" ] }, "deathBenefit": { "type": [ "string", "null" ] }, "term": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "maturityDate": { "description": "Policy maturity date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "riders": { "type": [ "string", "null" ] }, "coverageLevel": { "type": [ "string", "null" ], "enum": [ "Immediate", "Graded/ROP", "Modified Level", "Standard Level", "Preferred Level", null ] }, "draftDay": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "exchangeStatus": { "type": [ "string", "null" ], "enum": [ "FFM", "SBM", "SBM FP", "OFF EXCHANGE", "PRIVATE EXCHANGE", "UNKNOWN", null ] }, "billingMethod": { "type": [ "string", "null" ], "maxLength": 100 }, "benefitReminder": { "description": "Benefit reminder date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "surveyCompleted": { "type": [ "boolean", "null" ] }, "reasonForPurchase": { "type": [ "string", "null" ] }, "policyNotes": { "type": [ "string", "null" ] }, "customFields": { "description": "Policy custom fields after this sync, including definition metadata and the stored value.", "type": "array", "items": { "description": "Formatted custom field with definition and record-specific value", "type": "object", "properties": { "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldDefinitionId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "description": "The actual value for this record (type determined by fieldType). Dates are represented as ISO 8601 strings.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" }, {} ] } }, "additionalProperties": false } }, "previousStatus": { "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "customerId", "policyType", "policySubType", "policyNumber", "applicationId", "carrierId", "carrierName", "planName", "planCode", "carrierAssignedPolicyId", "healthSherpaPolicyId", "sunFireEnrollmentCode", "connectureConfirmationNumber", "hiosId", "metalLevel", "status", "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "cancelledDate", "declineReason", "declineReasonDescription", "cancellationReason", "cancellationReasonDescription", "electionPeriod", "gracePeriodStartDate", "paidThroughDate", "ffmApplicationId", "ffmSubscriberId", "aorAgentId", "aorFirstName", "aorLastName", "aorNpn", "writingAgentNpn", "writingAgentName", "sepType", "sepCode", "sepStartDate", "sepEndDate", "sepDocumentationReceived", "sepDocumentationDate", "sepNotes", "monthlyPremium", "deductible", "outOfPocketMax", "subsidyAmount", "usingSubsidy", "premiumMode", "paymentMode", "paymentMethod", "grossPremium", "netPremium", "initialCommission", "renewalCommission", "spifAmount", "policyLives", "wasAgent", "writtenAs", "isReplacing", "isRewrite", "hospitalNetwork", "pcpNetwork", "ssbciVerificationRequired", "dailyBenefit", "eliminationPeriod", "benefitPeriod", "hasCola", "deathBenefit", "term", "maturityDate", "riders", "coverageLevel", "draftDay", "exchangeStatus", "billingMethod", "benefitReminder", "surveyCompleted", "reasonForPurchase", "policyNotes", "customFields", "previousStatus" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "deletedAt", "externalId", "status", "firstName", "middleName", "lastName", "salutation", "suffix", "preferredName", "phoneNumber", "isPhonePrimary", "lineType", "email", "dateOfBirth", "language", "ethnicity", "gender", "maritalStatus", "address", "address2", "city", "county", "state", "postalCode", "timezone", "mbiNumber", "medicareCard", "medicarePartADate", "medicarePartBDate", "hasMedicaid", "medicaidNumber", "socialSecurityDisability", "heightInches", "weightPounds", "smokerStatus", "veteran", "vaNumber", "householdIncome", "annualIncome", "filingStatus", "dependentCount", "subsidyEligible", "subsidyAmount", "carrierAssignedCustomerId", "agentName", "agentNpn", "assignedUser", "doNotCall", "doNotSMS", "doNotEmail", "doNotMail", "testCustomer", "policies" ], "additionalProperties": false } }, "errors": { "description": "Errors for failed records (empty if all succeeded)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "externalId": { "type": [ "string", "null" ] }, "error": { "description": "Error message", "type": "string" } }, "required": [ "id", "externalId", "error" ], "additionalProperties": false } } }, "required": [ "succeeded", "failed", "results", "errors" ], "additionalProperties": false }, "PostV2SyncAcaNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncAcaNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncAcaNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncAcaNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2SyncAcaNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncAcaNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncAcaNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncAcaNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncAcaNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncAcaNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncAcaRequestBody": { "type": "object", "properties": { "records": { "description": "Array of ACA customer/policy records to sync (1-100)", "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "firstName": { "description": "Customer first name (required)", "type": "string", "maxLength": 255 }, "lastName": { "description": "Customer last name (required)", "type": "string", "maxLength": 255 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "postalCode": { "description": "Customer postal code. Required if timezone is not provided (for TCPA compliance).", "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Customer postal code. Required if timezone is not provided (for TCPA compliance).", "type": [ "string", "null" ] } ] }, "timezone": { "description": "Customer timezone. Required if postalCode is not provided (for TCPA compliance). \n\nAccepts IANA format (America/New_York) or abbreviations (EST, CST, MST, PST).", "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Customer timezone. Required if postalCode is not provided (for TCPA compliance). \n\nAccepts IANA format (America/New_York) or abbreviations (EST, CST, MST, PST).", "type": [ "string", "null" ] } ] }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Customer date of birth. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] } ] }, "maritalStatus": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] } ] }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 } ] }, "householdIncome": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 } ] }, "isDecisionMaker": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "medicaid": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "veteran": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "heightInches": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 } ] }, "weightPounds": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 } ] }, "smokerStatus": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "carrierAssignedCustomerId": { "description": "Carrier-assigned customer ID", "type": [ "string", "null" ], "maxLength": 255 }, "doNotCall": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "doNotSMS": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "doNotEmail": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "doNotMail": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "healthSherpaCustomerId": { "description": "Health Sherpa customer ID", "type": [ "string", "null" ], "maxLength": 255 }, "phoneNumber": { "description": "Customer phone number (required). Accepts: +1XXXXXXXXXX, XXXXXXXXXX, (XXX) XXX-XXXX", "type": "string" }, "externalId": { "description": "Your external system identifier for this customer", "type": [ "string", "null" ], "maxLength": 255 }, "customFields": { "description": "Customer custom field values (max 50). Find your configured keys in [Customer Custom Fields](https://app.carecycle.ai/settings/crm-settings/custom-fields/customer).", "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "description": "Custom field key (e.g., 'lead_source', 'utm_campaign')", "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "description": "Value for the custom field", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "fieldKey", "value" ] } }, "policies": { "description": "ACA policies to sync (max 10). policyType is set automatically to 'ACA'.", "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "planName": { "description": "Name of the policy", "examples": [ "Medicare Elite", "Blue Cross PPO" ], "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "description": "Plan code of the policy", "examples": [ "H1290-036-001" ], "type": [ "string", "null" ], "maxLength": 255 }, "carrierName": { "description": "Insurance carrier name. Resolved against the canonical carrier list at https://api.carecycle.ai/v2/carriers; accepts any carrier displayName or registered alias (e.g. 'UHC', 'BCBSIL', 'Cigna Health and Life Insurance Company'). Generic 'BCBS' / 'Blue Cross Blue Shield' inputs are disambiguated to the correct state plan using the customer's state.", "examples": [ "Aetna", "BCBS of TX", "UHC", "Anthem", "Florida Blue" ], "type": [ "string", "null" ], "maxLength": 255 }, "policyNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "policySubType": { "type": [ "string", "null" ], "maxLength": 100 }, "applicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierAssignedPolicyId": { "description": "Carrier-assigned policy ID (secondary identifier for matching)", "type": [ "string", "null" ], "maxLength": 255 }, "status": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "The current status of the policy", "default": "Active", "type": [ "string", "null" ], "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", null ] } ] }, "applicationApprovalDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Application approval date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "effectiveDate": { "description": "Policy effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] }, "terminationDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Policy termination date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "renewalDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Policy renewal date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "enrollmentDate": { "description": "Enrollment date (application submitted). Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] }, "cancelledDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Policy cancelled date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "electionPeriod": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "IEP", "AEP", "OEP", "SEP", "ICEP", "MA-OEP", null ] } ] }, "aorFirstName": { "description": "Agent Of Record First Name", "examples": [ "John", "Jane" ], "type": [ "string", "null" ], "maxLength": 255 }, "aorLastName": { "description": "Agent Of Record Last Name", "examples": [ "Doe", "Smith" ], "type": [ "string", "null" ], "maxLength": 255 }, "aorNpn": { "description": "Agent Of Record NPN", "examples": [ "123456789" ], "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentName": { "type": [ "string", "null" ], "maxLength": 255 }, "sepType": { "type": [ "string", "null" ], "maxLength": 255 }, "sepCode": { "type": [ "string", "null" ], "maxLength": 100 }, "sepStartDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "SEP start date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "sepEndDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "SEP end date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "sepDocumentationReceived": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "sepDocumentationDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "SEP documentation date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "sepNotes": { "type": [ "string", "null" ] }, "monthlyPremium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deductible": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "outOfPocketMax": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "initialCommission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "renewalCommission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "spifAmount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "policyLives": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Number of lives covered by the policy", "examples": [ 3 ], "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 } ] }, "wasAgent": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "writtenAs": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "New Business", "Like Plan Change", "Unlike Plan Change", "Reinstatement", "Rewrite", null ] } ] }, "isReplacing": { "type": [ "string", "null" ], "maxLength": 255 }, "isRewrite": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "reasonForPurchase": { "type": [ "string", "null" ] }, "policyNotes": { "type": [ "string", "null" ] }, "healthSherpaPolicyId": { "description": "Health Sherpa policy ID (primary identifier for matching)", "type": [ "string", "null" ], "maxLength": 255 }, "hiosId": { "type": [ "string", "null" ], "maxLength": 255 }, "metalLevel": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "Catastrophic", "Bronze", "Expanded Bronze", "Silver", "Gold", "Platinum", null ] } ] }, "gracePeriodStartDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Grace period start date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "paidThroughDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Coverage paid through date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "ffmApplicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "ffmSubscriberId": { "type": [ "string", "null" ], "maxLength": 255 }, "subsidyAmount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "usingSubsidy": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "premiumMode": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "Monthly", "Quarterly", "Semi-Annual", "Annual", null ] } ] }, "paymentMode": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "ACH", "Credit/ debit card", "Direct bill", null ] } ] }, "paymentMethod": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "Credit Card", "Debit Card", "Check", "ACH / Bank Draft", "Money Order", "Cash", "Other", null ] } ] }, "grossPremium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "netPremium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "exchangeStatus": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "FFM", "SBM", "SBM FP", "OFF EXCHANGE", "PRIVATE EXCHANGE", "UNKNOWN", null ] } ] }, "customFields": { "description": "Policy custom field values (max 50). Find your configured keys in [Policy Custom Fields](https://app.carecycle.ai/settings/crm-settings/custom-fields/policy). Values are written to the policy created or matched by this policy object.", "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "description": "Custom field key (e.g., 'lead_source', 'utm_campaign')", "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "description": "Value for the custom field", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "fieldKey", "value" ] } } }, "required": [ "planName", "planCode", "carrierName", "effectiveDate", "enrollmentDate", "aorNpn", "writingAgentNpn" ] } } }, "required": [ "firstName", "lastName", "phoneNumber" ] } } }, "required": [ "records" ] }, "PostV2SyncMedicarePositiveResponse": { "type": "object", "properties": { "succeeded": { "description": "Number of successfully synced records", "type": "number" }, "failed": { "description": "Number of failed records", "type": "number" }, "results": { "description": "The full customer record for each successfully synced row, each with the policies that this request changed", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "description": "Customer creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Customer last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "deletedAt": { "description": "Customer deletion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "externalId": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "firstName": { "type": [ "string", "null" ] }, "middleName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "salutation": { "type": [ "string", "null" ] }, "suffix": { "type": [ "string", "null" ] }, "preferredName": { "type": [ "string", "null" ] }, "phoneNumber": { "type": "string" }, "isPhonePrimary": { "type": "boolean" }, "lineType": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "language": { "type": [ "string", "null" ] }, "ethnicity": { "type": [ "string", "null" ] }, "gender": { "type": [ "string", "null" ] }, "maritalStatus": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "address2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "mbiNumber": { "type": [ "string", "null" ] }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "description": "Medicare Part A effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicarePartBDate": { "description": "Medicare Part B effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "hasMedicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ] }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "heightInches": { "type": [ "number", "null" ] }, "weightPounds": { "type": [ "number", "null" ] }, "smokerStatus": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ] }, "householdIncome": { "type": [ "number", "null" ] }, "annualIncome": { "type": [ "number", "null" ] }, "filingStatus": { "type": [ "string", "null" ] }, "dependentCount": { "type": [ "number", "null" ] }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "subsidyAmount": { "type": [ "number", "null" ] }, "carrierAssignedCustomerId": { "type": [ "string", "null" ] }, "agentName": { "type": [ "string", "null" ] }, "agentNpn": { "type": [ "number", "null" ] }, "assignedUser": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "npn": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "licensedStates": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "id", "name", "email", "npn", "role", "licensedStates" ], "additionalProperties": false }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "testCustomer": { "type": "boolean" }, "policies": { "description": "Policies changed by this request: those created or updated from the request, plus any older policies auto-terminated as a side effect. Does NOT include the customer's untouched existing policies.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Policy creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "updatedAt": { "description": "Policy last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedBy": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "policyType": { "type": "string", "enum": [ "MA", "MAPD", "PDP", "MS", "ACA", "LTC", "Individual Health", "FE", "Annuity", "Life", "Dental", "Vision", "Hospital Indemnity", "Cancer", "Critical Illness", "Accident", "Group", "Home Health Care", "International Travel" ] }, "policySubType": { "type": [ "string", "null" ], "maxLength": 100 }, "policyNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "applicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carrierName": { "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierAssignedPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "sunFireEnrollmentCode": { "type": [ "string", "null" ], "maxLength": 255 }, "connectureConfirmationNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "hiosId": { "type": [ "string", "null" ], "maxLength": 255 }, "metalLevel": { "type": [ "string", "null" ], "enum": [ "Catastrophic", "Bronze", "Expanded Bronze", "Silver", "Gold", "Platinum", null ] }, "status": { "type": [ "string", "null" ], "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", null ] }, "applicationApprovalDate": { "description": "Application approval date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "effectiveDate": { "description": "Policy effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "terminationDate": { "description": "Policy termination date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "renewalDate": { "description": "Policy renewal date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "enrollmentDate": { "description": "Policy enrollment date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "cancelledDate": { "description": "Policy cancellation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "declineReason": { "type": [ "string", "null" ] }, "declineReasonDescription": { "type": [ "string", "null" ] }, "cancellationReason": { "type": [ "string", "null" ] }, "cancellationReasonDescription": { "type": [ "string", "null" ] }, "electionPeriod": { "type": [ "string", "null" ], "enum": [ "IEP", "AEP", "OEP", "SEP", "ICEP", "MA-OEP", null ] }, "gracePeriodStartDate": { "description": "Grace period start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "paidThroughDate": { "description": "Coverage paid-through date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "ffmApplicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "ffmSubscriberId": { "type": [ "string", "null" ], "maxLength": 255 }, "aorAgentId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "aorFirstName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorLastName": { "type": [ "string", "null" ], "maxLength": 255 }, "aorNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentName": { "type": [ "string", "null" ], "maxLength": 255 }, "sepType": { "type": [ "string", "null" ], "maxLength": 255 }, "sepCode": { "type": [ "string", "null" ], "maxLength": 100 }, "sepStartDate": { "description": "SEP start date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepEndDate": { "description": "SEP end date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepDocumentationReceived": { "type": [ "boolean", "null" ] }, "sepDocumentationDate": { "description": "SEP documentation date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "sepNotes": { "type": [ "string", "null" ] }, "monthlyPremium": { "type": [ "string", "null" ] }, "deductible": { "type": [ "string", "null" ] }, "outOfPocketMax": { "type": [ "string", "null" ] }, "subsidyAmount": { "type": [ "string", "null" ] }, "usingSubsidy": { "type": [ "boolean", "null" ] }, "premiumMode": { "type": [ "string", "null" ], "enum": [ "Monthly", "Quarterly", "Semi-Annual", "Annual", null ] }, "paymentMode": { "type": [ "string", "null" ], "enum": [ "ACH", "Credit/ debit card", "Direct bill", null ] }, "paymentMethod": { "type": [ "string", "null" ], "enum": [ "Credit Card", "Debit Card", "Check", "ACH / Bank Draft", "Money Order", "Cash", "Other", null ] }, "grossPremium": { "type": [ "string", "null" ] }, "netPremium": { "type": [ "string", "null" ] }, "initialCommission": { "type": [ "string", "null" ] }, "renewalCommission": { "type": [ "string", "null" ] }, "spifAmount": { "type": [ "string", "null" ] }, "policyLives": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "wasAgent": { "type": [ "boolean", "null" ] }, "writtenAs": { "type": [ "string", "null" ], "enum": [ "New Business", "Like Plan Change", "Unlike Plan Change", "Reinstatement", "Rewrite", null ] }, "isReplacing": { "type": [ "string", "null" ], "maxLength": 255 }, "isRewrite": { "type": [ "boolean", "null" ] }, "hospitalNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "pcpNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "ssbciVerificationRequired": { "type": [ "boolean", "null" ] }, "dailyBenefit": { "type": [ "string", "null" ] }, "eliminationPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "benefitPeriod": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "hasCola": { "type": [ "boolean", "null" ] }, "deathBenefit": { "type": [ "string", "null" ] }, "term": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "maturityDate": { "description": "Policy maturity date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "riders": { "type": [ "string", "null" ] }, "coverageLevel": { "type": [ "string", "null" ], "enum": [ "Immediate", "Graded/ROP", "Modified Level", "Standard Level", "Preferred Level", null ] }, "draftDay": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "exchangeStatus": { "type": [ "string", "null" ], "enum": [ "FFM", "SBM", "SBM FP", "OFF EXCHANGE", "PRIVATE EXCHANGE", "UNKNOWN", null ] }, "billingMethod": { "type": [ "string", "null" ], "maxLength": 100 }, "benefitReminder": { "description": "Benefit reminder date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "surveyCompleted": { "type": [ "boolean", "null" ] }, "reasonForPurchase": { "type": [ "string", "null" ] }, "policyNotes": { "type": [ "string", "null" ] }, "customFields": { "description": "Policy custom fields after this sync, including definition metadata and the stored value.", "type": "array", "items": { "description": "Formatted custom field with definition and record-specific value", "type": "object", "properties": { "fieldKey": { "description": "Generated identifier for the field", "type": "string", "maxLength": 100 }, "fieldLabel": { "description": "Display name shown to users", "type": "string", "maxLength": 255 }, "fieldDescription": { "description": "Description of the field's purpose", "type": "string" }, "fieldType": { "description": "Type of data this field stores", "type": "string", "enum": [ "text", "number", "boolean", "date", "select", "multi_select" ] }, "isRequired": { "description": "Whether this field must have a value", "type": [ "boolean", "null" ] }, "options": { "description": "Available options for select/multi-select fields", "type": [ "array", "null" ], "items": { "type": "string" } }, "validationRules": { "description": "Validation rules for the custom field", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldDefinitionId": { "description": "Custom field definition ID", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "value": { "description": "The actual value for this record (type determined by fieldType). Dates are represented as ISO 8601 strings.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" }, {} ] } }, "additionalProperties": false } }, "previousStatus": { "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "createdBy", "updatedAt", "updatedBy", "customerId", "policyType", "policySubType", "policyNumber", "applicationId", "carrierId", "carrierName", "planName", "planCode", "carrierAssignedPolicyId", "healthSherpaPolicyId", "sunFireEnrollmentCode", "connectureConfirmationNumber", "hiosId", "metalLevel", "status", "applicationApprovalDate", "effectiveDate", "terminationDate", "renewalDate", "enrollmentDate", "cancelledDate", "declineReason", "declineReasonDescription", "cancellationReason", "cancellationReasonDescription", "electionPeriod", "gracePeriodStartDate", "paidThroughDate", "ffmApplicationId", "ffmSubscriberId", "aorAgentId", "aorFirstName", "aorLastName", "aorNpn", "writingAgentNpn", "writingAgentName", "sepType", "sepCode", "sepStartDate", "sepEndDate", "sepDocumentationReceived", "sepDocumentationDate", "sepNotes", "monthlyPremium", "deductible", "outOfPocketMax", "subsidyAmount", "usingSubsidy", "premiumMode", "paymentMode", "paymentMethod", "grossPremium", "netPremium", "initialCommission", "renewalCommission", "spifAmount", "policyLives", "wasAgent", "writtenAs", "isReplacing", "isRewrite", "hospitalNetwork", "pcpNetwork", "ssbciVerificationRequired", "dailyBenefit", "eliminationPeriod", "benefitPeriod", "hasCola", "deathBenefit", "term", "maturityDate", "riders", "coverageLevel", "draftDay", "exchangeStatus", "billingMethod", "benefitReminder", "surveyCompleted", "reasonForPurchase", "policyNotes", "customFields", "previousStatus" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "updatedAt", "deletedAt", "externalId", "status", "firstName", "middleName", "lastName", "salutation", "suffix", "preferredName", "phoneNumber", "isPhonePrimary", "lineType", "email", "dateOfBirth", "language", "ethnicity", "gender", "maritalStatus", "address", "address2", "city", "county", "state", "postalCode", "timezone", "mbiNumber", "medicareCard", "medicarePartADate", "medicarePartBDate", "hasMedicaid", "medicaidNumber", "socialSecurityDisability", "heightInches", "weightPounds", "smokerStatus", "veteran", "vaNumber", "householdIncome", "annualIncome", "filingStatus", "dependentCount", "subsidyEligible", "subsidyAmount", "carrierAssignedCustomerId", "agentName", "agentNpn", "assignedUser", "doNotCall", "doNotSMS", "doNotEmail", "doNotMail", "testCustomer", "policies" ], "additionalProperties": false } }, "errors": { "description": "Errors for failed records (empty if all succeeded)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "externalId": { "type": [ "string", "null" ] }, "error": { "description": "Error message", "type": "string" } }, "required": [ "id", "externalId", "error" ], "additionalProperties": false } } }, "required": [ "succeeded", "failed", "results", "errors" ], "additionalProperties": false }, "PostV2SyncMedicareNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncMedicareNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncMedicareNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncMedicareNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2SyncMedicareNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncMedicareNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncMedicareNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncMedicareNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncMedicareNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncMedicareNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SyncMedicareRequestBody": { "type": "object", "properties": { "records": { "description": "Array of Medicare customer/policy records to sync (1-100)", "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 255 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "postalCode": { "description": "Customer postal code. Required if timezone is not provided (for TCPA compliance).", "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Customer postal code. Required if timezone is not provided (for TCPA compliance).", "type": [ "string", "null" ] } ] }, "timezone": { "description": "Customer timezone. Required if postalCode is not provided (for TCPA compliance). \n\n Accepts IANA format (America/New_York) or abbreviations (EST, CST, MST, PST).", "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Customer timezone. Required if postalCode is not provided (for TCPA compliance). \n\n Accepts IANA format (America/New_York) or abbreviations (EST, CST, MST, PST).", "type": [ "string", "null" ] } ] }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Customer date of birth. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] } ] }, "maritalStatus": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] } ] }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 } ] }, "householdIncome": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 } ] }, "isDecisionMaker": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "medicaid": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "veteran": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "heightInches": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 } ] }, "weightPounds": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 } ] }, "smokerStatus": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "carrierAssignedCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "doNotCall": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "doNotSMS": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "doNotEmail": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "doNotMail": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "healthSherpaCustomerId": { "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "description": "Medicare Beneficiary Identifier", "type": "string", "minLength": 1, "maxLength": 255 }, "medicareCard": { "description": "Whether the customer has their Medicare card", "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Whether the customer has their Medicare card", "type": [ "boolean", "null" ] } ] }, "medicarePartADate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Medicare Part A effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "medicarePartBDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Medicare Part B effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "externalId": { "description": "Your external system identifier for this customer", "type": [ "string", "null" ], "maxLength": 255 }, "phoneNumber": { "description": "Customer phone number (required). Accepts: +1XXXXXXXXXX, XXXXXXXXXX, (XXX) XXX-XXXX", "type": "string" }, "customFields": { "description": "Customer custom field values (max 50). Find your configured keys in [Customer Custom Fields](https://app.carecycle.ai/settings/crm-settings/custom-fields/customer).", "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "description": "Custom field key (e.g., 'lead_source', 'utm_campaign')", "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "description": "Value for the custom field", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "fieldKey", "value" ] } }, "policies": { "description": "Medicare policies to sync (max 10). policyType must be MA, MAPD, MS, or PDP.", "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "policySubType": { "type": [ "string", "null" ], "maxLength": 100 }, "policyNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "applicationId": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierName": { "description": "Insurance carrier name. Resolved against the canonical carrier list at https://api.carecycle.ai/v2/carriers; accepts any carrier displayName or registered alias (e.g. 'UHC', 'BCBSIL', 'Cigna Health and Life Insurance Company'). Generic 'BCBS' / 'Blue Cross Blue Shield' inputs are disambiguated to the correct state plan using the customer's state.", "examples": [ "Aetna", "BCBS of TX", "UHC", "Anthem", "Florida Blue" ], "type": [ "string", "null" ], "maxLength": 255 }, "planName": { "description": "Name of the policy", "examples": [ "Medicare Elite", "Blue Cross PPO" ], "type": [ "string", "null" ], "maxLength": 255 }, "planCode": { "type": [ "string", "null" ], "maxLength": 255 }, "carrierAssignedPolicyId": { "type": [ "string", "null" ], "maxLength": 255 }, "status": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "The current status of the policy", "default": "Active", "type": [ "string", "null" ], "enum": [ "Active", "Placed", "Pending", "Pending Effectuation", "Pending Followup", "Suspended", "Cancelled", "Terminated", "Future Cancel", "Deceased", "Not Approved", null ] } ] }, "applicationApprovalDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Application approval date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "effectiveDate": { "description": "Policy effective date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] }, "terminationDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Policy termination date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "renewalDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Policy renewal date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "enrollmentDate": { "description": "Enrollment date (application submitted). Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] }, "cancelledDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Policy cancelled date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "electionPeriod": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "IEP", "AEP", "OEP", "SEP", "ICEP", "MA-OEP", null ] } ] }, "aorAgentId": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } ] }, "aorFirstName": { "description": "Agent Of Record First Name", "examples": [ "John", "Jane" ], "type": [ "string", "null" ], "maxLength": 255 }, "aorLastName": { "description": "Agent Of Record Last Name", "examples": [ "Doe", "Smith" ], "type": [ "string", "null" ], "maxLength": 255 }, "aorNpn": { "description": "Agent Of Record NPN", "examples": [ "123456789" ], "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentNpn": { "type": [ "string", "null" ], "maxLength": 50 }, "writingAgentName": { "type": [ "string", "null" ], "maxLength": 255 }, "sepType": { "type": [ "string", "null" ], "maxLength": 255 }, "sepCode": { "type": [ "string", "null" ], "maxLength": 100 }, "sepStartDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "SEP start date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "sepEndDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "SEP end date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "sepDocumentationReceived": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "sepDocumentationDate": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "SEP documentation date. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] } ] }, "sepNotes": { "type": [ "string", "null" ] }, "monthlyPremium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "premiumMode": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "Monthly", "Quarterly", "Semi-Annual", "Annual", null ] } ] }, "paymentMode": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "ACH", "Credit/ debit card", "Direct bill", null ] } ] }, "paymentMethod": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "Credit Card", "Debit Card", "Check", "ACH / Bank Draft", "Money Order", "Cash", "Other", null ] } ] }, "deductible": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "outOfPocketMax": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "initialCommission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "renewalCommission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "spifAmount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "policyLives": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "description": "Number of lives covered by the policy", "examples": [ 3 ], "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 } ] }, "wasAgent": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "writtenAs": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "string", "null" ], "enum": [ "New Business", "Like Plan Change", "Unlike Plan Change", "Reinstatement", "Rewrite", null ] } ] }, "isReplacing": { "type": [ "string", "null" ], "maxLength": 255 }, "isRewrite": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "reasonForPurchase": { "type": [ "string", "null" ] }, "policyNotes": { "type": [ "string", "null" ] }, "sunFireEnrollmentCode": { "description": "SunFire enrollment code (primary identifier for matching)", "type": [ "string", "null" ], "maxLength": 255 }, "hospitalNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "pcpNetwork": { "type": [ "string", "null" ], "maxLength": 255 }, "ssbciVerificationRequired": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": [ "boolean", "null" ] } ] }, "policyType": { "description": "Policy type (required). Must be one of: MA, MAPD, MS, PDP", "type": "string", "enum": [ "MA", "MAPD", "MS", "PDP" ] }, "customFields": { "description": "Policy custom field values (max 50). Find your configured keys in [Policy Custom Fields](https://app.carecycle.ai/settings/crm-settings/custom-fields/policy). Values are written to the policy created or matched by this policy object.", "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "description": "Custom field key (e.g., 'lead_source', 'utm_campaign')", "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "description": "Value for the custom field", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "fieldKey", "value" ] } } }, "required": [ "carrierName", "planName", "planCode", "effectiveDate", "enrollmentDate", "aorNpn", "writingAgentNpn", "policyType" ] } } }, "required": [ "firstName", "lastName", "mbiNumber", "phoneNumber" ] } } }, "required": [ "records" ] }, "PostV2LeadsUploadPositiveResponse": { "type": "object", "properties": { "succeeded": { "description": "Number of successfully uploaded records", "type": "number" }, "failed": { "description": "Number of failed records", "type": "number" }, "results": { "description": "Full customer record for each successfully uploaded record", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "description": "Customer creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "description": "Customer last update time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "deletedAt": { "description": "Customer deletion time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" }, "externalId": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "firstName": { "type": [ "string", "null" ] }, "middleName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "salutation": { "type": [ "string", "null" ] }, "suffix": { "type": [ "string", "null" ] }, "preferredName": { "type": [ "string", "null" ] }, "phoneNumber": { "type": "string" }, "isPhonePrimary": { "type": "boolean" }, "lineType": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "dateOfBirth": { "description": "Customer date of birth. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "language": { "type": [ "string", "null" ] }, "ethnicity": { "type": [ "string", "null" ] }, "gender": { "type": [ "string", "null" ] }, "maritalStatus": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "address2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "postalCode": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "mbiNumber": { "type": [ "string", "null" ] }, "medicareCard": { "type": [ "boolean", "null" ] }, "medicarePartADate": { "description": "Medicare Part A effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "medicarePartBDate": { "description": "Medicare Part B effective date. Canonical format: YYYY-MM-DD", "type": [ "string", "null" ], "format": "date" }, "hasMedicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ] }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "heightInches": { "type": [ "number", "null" ] }, "weightPounds": { "type": [ "number", "null" ] }, "smokerStatus": { "type": [ "boolean", "null" ] }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ] }, "householdIncome": { "type": [ "number", "null" ] }, "annualIncome": { "type": [ "number", "null" ] }, "filingStatus": { "type": [ "string", "null" ] }, "dependentCount": { "type": [ "number", "null" ] }, "subsidyEligible": { "type": [ "boolean", "null" ] }, "subsidyAmount": { "type": [ "number", "null" ] }, "carrierAssignedCustomerId": { "type": [ "string", "null" ] }, "agentName": { "type": [ "string", "null" ] }, "agentNpn": { "type": [ "number", "null" ] }, "assignedUser": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "npn": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "licensedStates": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "id", "name", "email", "npn", "role", "licensedStates" ], "additionalProperties": false }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "testCustomer": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "deletedAt", "externalId", "status", "firstName", "middleName", "lastName", "salutation", "suffix", "preferredName", "phoneNumber", "isPhonePrimary", "lineType", "email", "dateOfBirth", "language", "ethnicity", "gender", "maritalStatus", "address", "address2", "city", "county", "state", "postalCode", "timezone", "mbiNumber", "medicareCard", "medicarePartADate", "medicarePartBDate", "hasMedicaid", "medicaidNumber", "socialSecurityDisability", "heightInches", "weightPounds", "smokerStatus", "veteran", "vaNumber", "householdIncome", "annualIncome", "filingStatus", "dependentCount", "subsidyEligible", "subsidyAmount", "carrierAssignedCustomerId", "agentName", "agentNpn", "assignedUser", "doNotCall", "doNotSMS", "doNotEmail", "doNotMail", "testCustomer" ], "additionalProperties": false } }, "errors": { "description": "Errors for failed records (empty if all succeeded)", "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "externalId": { "type": [ "string", "null" ] }, "error": { "description": "Error message", "type": "string" } }, "required": [ "id", "externalId", "error" ], "additionalProperties": false } } }, "required": [ "succeeded", "failed", "results", "errors" ], "additionalProperties": false }, "PostV2LeadsUploadNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2LeadsUploadNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2LeadsUploadNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2LeadsUploadNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2LeadsUploadNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2LeadsUploadNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2LeadsUploadNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2LeadsUploadNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2LeadsUploadNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2LeadsUploadNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2LeadsUploadRequestBody": { "type": "object", "properties": { "records": { "description": "Array of lead records to upload (1-200)", "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "firstName": { "description": "Customer first name", "type": [ "string", "null" ], "maxLength": 255 }, "lastName": { "description": "Customer last name", "type": [ "string", "null" ], "maxLength": 255 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "postalCode": { "description": "Customer postal code. Required if timezone is not provided (for TCPA compliance).", "type": [ "string", "null" ] }, "timezone": { "description": "Customer timezone. Required if postalCode is not provided (for TCPA compliance). \n\nAccepts IANA format (America/New_York) or abbreviations (EST, CST, MST, PST).", "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "county": { "type": [ "string", "null" ], "maxLength": 255 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "address2": { "type": [ "string", "null" ], "maxLength": 255 }, "dateOfBirth": { "description": "Customer date of birth. Format: MM-DD-YYYY, MM/DD/YYYY, or YYYY-MM-DD", "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ], "maxLength": 50 }, "gender": { "type": [ "string", "null" ], "enum": [ "Male", "Female", "Non-Binary", "Other", "Prefer Not to Say", null ] }, "maritalStatus": { "type": [ "string", "null" ], "enum": [ "Single", "Married", "Divorced", "Widowed", "Separated", "Domestic Partnership", null ] }, "filingStatus": { "type": [ "string", "null" ], "maxLength": 50 }, "dependentCount": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "householdIncome": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "isDecisionMaker": { "type": [ "boolean", "null" ] }, "medicaid": { "type": [ "boolean", "null" ] }, "medicaidNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "veteran": { "type": [ "boolean", "null" ] }, "vaNumber": { "type": [ "string", "null" ], "maxLength": 255 }, "socialSecurityDisability": { "type": [ "boolean", "null" ] }, "heightInches": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "weightPounds": { "type": [ "integer", "null" ], "minimum": -2147483648, "maximum": 2147483647 }, "smokerStatus": { "type": [ "boolean", "null" ] }, "carrierAssignedCustomerId": { "description": "Carrier-assigned customer ID", "type": [ "string", "null" ], "maxLength": 255 }, "healthSherpaCustomerId": { "description": "Health Sherpa customer ID", "type": [ "string", "null" ], "maxLength": 255 }, "mbiNumber": { "description": "Medicare Beneficiary Identifier", "type": [ "string", "null" ], "maxLength": 255 }, "doNotCall": { "type": [ "boolean", "null" ] }, "doNotSMS": { "type": [ "boolean", "null" ] }, "doNotEmail": { "type": [ "boolean", "null" ] }, "doNotMail": { "type": [ "boolean", "null" ] }, "phoneNumber": { "description": "Customer phone number (required). Accepts: +1XXXXXXXXXX, XXXXXXXXXX, (XXX) XXX-XXXX", "type": "string" }, "externalId": { "description": "Your external system identifier for this customer", "type": [ "string", "null" ], "maxLength": 255 }, "sourceId": { "description": "Public source identifier configured in careCycle. The source must exist before leads are uploaded. You may also pass the source UUID.", "type": [ "string", "null" ], "maxLength": 255 }, "leadCost": { "description": "Optional per-lead cost for dynamic CPL source billing. If omitted, the source default lead cost is used.", "type": [ "number", "null" ], "minimum": 0 }, "customFields": { "description": "Custom field values (max 50) \n\n Your Custom Field keys can be found [here](https://app.carecycle.ai/settings/crm-settings/custom-fields/customer) in your settings", "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "description": "Custom field key (e.g., 'lead_source', 'utm_campaign')", "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "description": "Value for the custom field", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "fieldKey", "value" ] } } }, "required": [ "phoneNumber" ] } } }, "required": [ "records" ] }, "GetV2SandboxCallsCallIdStatusParameterCallId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "GetV2SandboxCallsCallIdStatusPositiveResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "dialing", "ringing", "connected", "completed", "failed" ] }, "disposition": { "type": [ "string", "null" ] }, "endedReason": { "type": [ "string", "null" ] }, "answered": { "type": "boolean" }, "durationMs": { "type": [ "number", "null" ] }, "failureDetail": { "type": [ "string", "null" ] } }, "required": [ "status", "disposition", "endedReason", "answered", "durationMs", "failureDetail" ], "additionalProperties": false }, "GetV2SandboxCallsCallIdStatusNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxCallsCallIdStatusNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxCallsCallIdStatusNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxCallsCallIdStatusNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2SandboxCallsCallIdStatusNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxCallsCallIdStatusNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxCallsCallIdStatusNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxCallsCallIdStatusNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxCallsCallIdStatusNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxCallsCallIdStatusNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxCallsPositiveResponse": { "type": "object", "properties": { "callId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "testCustomerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string", "enum": [ "initiated", "missing_variables" ] }, "missingVars": { "type": "array", "items": { "type": "string" } }, "availableVars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "requiredVars": { "type": "array", "items": { "type": "string" } } }, "required": [ "callId", "testCustomerId", "status" ], "additionalProperties": false }, "PostV2SandboxCallsNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxCallsNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxCallsNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxCallsNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2SandboxCallsNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxCallsNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxCallsNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxCallsNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxCallsNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxCallsNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxCallsRequestBody": { "type": "object", "properties": { "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assistantId": { "type": "string" }, "phoneNumber": { "description": "E.164 phone number to call. Auto-resolved from your registered test number if omitted.", "type": "string", "pattern": "^\\+[1-9]\\d{6,14}$" }, "clientId": { "description": "Target client organization ID. Super admin only; omit to use your own organization.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "customerData": { "description": "Customer profile and policy fields to set on the test customer before calling. Accepts any clientCustomer field (firstName, lastName, postalCode, timezone, dateOfBirth, state, etc.) and policy fields (carrierName, planName, planCode, effectiveDate, enrollmentDate). Protected fields (id, clientId, callerId) are ignored.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "campaignId", "assistantId" ] }, "DeleteV2SandboxNumbersIdParameterId": { "type": "number" }, "DeleteV2SandboxNumbersIdPositiveResponse": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "DeleteV2SandboxNumbersIdNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SandboxNumbersIdNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SandboxNumbersIdNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SandboxNumbersIdNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "DeleteV2SandboxNumbersIdNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SandboxNumbersIdNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SandboxNumbersIdNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SandboxNumbersIdNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SandboxNumbersIdNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "DeleteV2SandboxNumbersIdNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxNumbersPositiveResponse": { "type": "object", "properties": { "numbers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "phoneNumber": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string" }, "memberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "description": "Sandbox number creation time. ISO 8601 timestamp", "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "phoneNumber", "label", "type", "memberId", "createdAt" ], "additionalProperties": false } }, "testCustomerId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "numbers", "testCustomerId" ], "additionalProperties": false }, "GetV2SandboxNumbersNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxNumbersNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxNumbersNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxNumbersNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "GetV2SandboxNumbersNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxNumbersNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxNumbersNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxNumbersNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxNumbersNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "GetV2SandboxNumbersNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxNumbersPositiveResponse": { "type": "object", "properties": { "id": { "type": "number" }, "phoneNumber": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string" }, "memberId": { "type": [ "string", "null" ], "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "phoneNumber", "label", "type", "memberId" ], "additionalProperties": false }, "PostV2SandboxNumbersNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxNumbersNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxNumbersNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxNumbersNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2SandboxNumbersNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxNumbersNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxNumbersNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxNumbersNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxNumbersNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxNumbersNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2SandboxNumbersRequestBody": { "type": "object", "properties": { "phoneNumber": { "description": "E.164 phone number to register for testing", "type": "string", "pattern": "^\\+[1-9]\\d{6,14}$" }, "label": { "description": "Optional label for this number", "type": "string", "maxLength": 100 }, "memberId": { "description": "Member ID to assign this number to. Defaults to the authenticated member.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "phoneNumber" ] }, "PostV2PingPositiveResponse": { "type": "object", "properties": { "agent_available": { "description": "Whether the call can be taken right now", "type": "boolean" }, "number": { "type": [ "string", "null" ] }, "expires_in_seconds": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "reason": { "description": "Machine-readable reason when agent_available is false", "type": "string", "enum": [ "caller_suppressed", "campaign_inactive", "no_agents_available", "after_hours", "no_live_coverage", "no_licensed_agents" ] } }, "required": [ "agent_available", "number", "expires_in_seconds" ], "additionalProperties": false }, "PostV2PingNegativeResponse400": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PingNegativeResponse409": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PingNegativeResponse404": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PingNegativeResponse422": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "VALIDATION_ERROR" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "expected": { "type": "string" }, "received": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message", "code" ], "additionalProperties": false } }, "failedRecords": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "phoneNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "index" ], "additionalProperties": false } } }, "required": [ "message", "code", "errors" ], "additionalProperties": false }, "PostV2PingNegativeResponse429": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "retryAfter": { "type": "number" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PingNegativeResponse401": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PingNegativeResponse403": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PingNegativeResponse500": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PingNegativeResponse502": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PingNegativeResponse503": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false }, "PostV2PingRequestBody": { "type": "object", "properties": { "source_id": { "description": "Public source identifier assigned by careCycle", "type": "string", "minLength": 1 }, "campaign_source_id": { "description": "Campaign-source assignment ID. Required when the source has more than one enabled live-call destination.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "caller_id": { "description": "Phone number of the caller you intend to transfer (North American, with or without +1)", "type": "string", "minLength": 1 }, "transfer_consent": { "description": "Attestation that a permitted consent basis applies: the caller verbally agreed to the transfer during the live call (agent script or IVR prompt), the caller placed this call themselves to be connected (direct dial / click-to-call), or prior express written consent naming the agency is on file. Required; pings without it are rejected.", "type": "boolean", "const": true }, "consent_basis": { "description": "Which basis applies: verbal_agreement (caller said yes to the transfer, to a human or an IVR prompt), caller_initiated (caller dialed a number that connects here), pewc (prior express written consent naming the agency). Strongly recommended for audit trails.", "type": "string", "enum": [ "verbal_agreement", "caller_initiated", "pewc" ] }, "sub_id": { "description": "Optional vendor traffic granularity below the source", "type": "string", "maxLength": 255 }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "date_of_birth": { "description": "YYYY-MM-DD preferred; alias: dob. Optional; age or birth year is enough for routing; send full DOB only if you already have it", "type": "string" }, "dob": { "type": "string" }, "state": { "description": "Two-letter state code. When the receiving campaign routes by agent licensure, availability is checked against agents licensed in this state; without it, the answer cannot account for licensing", "type": "string" }, "postal_code": { "description": "5-digit postal code; alias: zip_code", "type": "string" }, "zip_code": { "type": "string" }, "existing_coverage": { "type": "string" }, "household_income": { "type": "string" }, "qualification_status": { "type": "string" }, "filing_status": { "type": "string" }, "dependents": { "type": "string" }, "consent_timestamp": { "description": "ISO timestamp of the caller's verbal transfer agreement", "type": "string", "format": "date-time" }, "pewc_artifact": { "description": "Reference (URL or ID) to prior express written consent naming the receiving agency, when relying on PEWC instead of the live-transfer carve-out", "type": "string" }, "trustedform_cert_url": { "description": "TrustedForm certificate URL of the originating web opt-in", "type": "string" }, "truecall_id": { "description": "ActiveProspect TrueCall ID proving consumer-initiated call", "type": "string" }, "jornaya_leadid": { "description": "Jornaya LeadiD token of the originating lead", "type": "string" }, "agent_npn": { "description": "NPN of the transferring licensed agent, when agent-initiated", "type": "string" } }, "required": [ "source_id", "caller_id", "transfer_consent" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "x-api-key": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "API key required for authentication. \n\nKeys begin with 'cc_' prefix. Get your API key from the [Developer Dashboard](https://app.carecycle.ai/settings/developer/api-keys)." } }, "links": {}, "callbacks": {} }, "tags": [], "servers": [ { "url": "https://api.carecycle.ai" } ] }