{ "openapi": "3.1.0", "info": { "title": "Unify Sequences API", "summary": "Interact with sequences and sequence enrollments within the Unify platform.", "version": "1", "termsOfService": "https://www.unifygtm.com/legal/terms-and-conditions", "contact": { "name": "Unify Support", "url": "https://www.unifygtm.com/support", "email": "support@unifygtm.com" } }, "tags": [ { "name": "Sequences" }, { "name": "Sequence Enrollment Steps" }, { "name": "Sequence Enrollments" } ], "paths": { "/enrollment-steps/query-jobs": { "post": { "operationId": "create_sequence_enrollment_step_query_job", "description": "Start an asynchronous query job that exports sequence enrollment steps \u2014\nper-person executions of each sequence step, including sent email\nengagement and any reply. Omitting `filter` exports all enrollment\nsteps. Poll the job until it is `FINISHED`, then page through the\nresults.", "parameters": [], "responses": { "201": { "description": "Response returned when creating a Bulk API query job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBulkApiJobSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollment Steps" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBulkApiSequenceEnrollmentStepsJobRequest" } } } }, "x-mcp-tool": { "destructiveHint": false, "openWorldHint": false } }, "get": { "operationId": "list_sequence_enrollment_step_query_jobs", "description": "List sequence enrollment step query jobs, optionally filtered by status.", "parameters": [ { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor returned by the previous page.", "schema": { "type": "string" }, "explode": false }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "explode": false }, { "name": "status", "in": "query", "required": false, "description": "Filter jobs by status.", "schema": { "$ref": "#/components/schemas/BulkApiJobStatus" }, "explode": false } ], "responses": { "200": { "description": "Response returned when listing Bulk API jobs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBulkApiJobsSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollment Steps" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } } }, "/enrollment-steps/query-jobs/{job_id}": { "get": { "operationId": "get_sequence_enrollment_step_query_job", "description": "Get a query job's status. Poll until the status is terminal; results are\navailable once the job is `FINISHED`. Jobs expire 24 hours after\ncreation.", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response returned when fetching a Bulk API job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a Bulk API job cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobNotFoundResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollment Steps" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } } }, "/enrollment-steps/query-jobs/{job_id}/cancel": { "post": { "operationId": "cancel_sequence_enrollment_step_query_job", "description": "Cancel a query job. Only `IN_PROGRESS` jobs can be canceled.", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response returned when canceling a Bulk API job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelBulkApiJobSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a Bulk API job cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobNotFoundResponse" } } } }, "409": { "description": "Response returned when a Bulk API job is not cancelable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelBulkApiJobNotCancelableResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollment Steps" ], "x-mcp-tool": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false } } }, "/enrollment-steps/query-jobs/{job_id}/results": { "get": { "operationId": "get_sequence_enrollment_step_query_job_results", "description": "Get Bulk API job results. By default this returns JSON. Send\n`Accept: application/x-ndjson` to stream newline-delimited JSON.", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "explode": false }, { "name": "page_size", "in": "query", "required": false, "description": "Maximum is 2,000 for JSON responses and 10,000 when `Accept` is\n`application/x-ndjson`.", "schema": { "type": "integer", "minimum": 1, "maximum": 10000 }, "explode": false } ], "responses": { "200": { "description": "Successful response returned when fetching completed Bulk API job results.", "headers": { "x-total": { "required": false, "description": "Total result count. Present for NDJSON responses.", "schema": { "type": "integer" } }, "x-page": { "required": false, "description": "Result page number. Present for NDJSON responses.", "schema": { "type": "integer" } }, "x-page-size": { "required": false, "description": "Result page size. Present for NDJSON responses.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "total", "page", "page_size", "data" ], "properties": { "total": { "type": "integer" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStep" } } }, "description": "Successful response returned when fetching completed Bulk API job results." } }, "application/x-ndjson": { "schema": { "type": "string" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a Bulk API job cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobNotFoundResponse" } } } }, "409": { "description": "Response returned when Bulk API job results are not ready yet.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/GetBulkApiJobResultsNotReadyResponse" }, { "$ref": "#/components/schemas/GetBulkApiJobResultsFailedResponse" }, { "$ref": "#/components/schemas/GetBulkApiJobResultsCanceledResponse" } ] } } } }, "410": { "description": "Response returned when Bulk API job results have expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobResultsExpiredResponse" } } } }, "413": { "description": "Response returned when a requested Bulk API results page is too large.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobResultsPayloadTooLargeResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollment Steps" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } } }, "/enrollments": { "post": { "operationId": "create_sequence_enrollment", "description": "Enroll a person in a sequence. `mailbox_emails` lists candidate sending\nmailboxes, one of which is selected at enrollment time. If the person is\nalready actively enrolled in a sequence, the request fails with a `409`\nidentifying the active enrollment.", "parameters": [], "responses": { "201": { "description": "Response returned when an enrollment is created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnrollmentSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when an enrollment cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentNotFoundResponse" } } } }, "409": { "description": "Response returned when the person is already enrolled in an active sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnrollmentConflictResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnrollmentRequest" } } } }, "x-mcp-tool": { "destructiveHint": false } }, "get": { "operationId": "list_sequence_enrollments", "description": "List sequence enrollments \u2014 each tracks one person's progress through a\nsequence along with reply, bounce, opt-out, and pause state.", "parameters": [ { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor returned by the previous page.", "schema": { "type": "string" }, "explode": false }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "explode": false }, { "name": "sequence_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/uuid" }, "explode": false }, { "name": "person_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/uuid" }, "explode": false }, { "name": "mailbox_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/uuid" }, "explode": false }, { "name": "enrolled_by_play_id", "in": "query", "required": false, "description": "Filter to enrollments created by this play.", "schema": { "$ref": "#/components/schemas/uuid" }, "explode": false }, { "name": "status", "in": "query", "required": false, "description": "Repeat `status` to filter by multiple enrollment statuses.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStatus" } } }, { "name": "updated_after", "in": "query", "required": false, "description": "Inclusive lower bound on `updated_at`.", "schema": { "$ref": "#/components/schemas/datetime" }, "explode": false }, { "name": "updated_before", "in": "query", "required": false, "description": "Inclusive upper bound on `updated_at`.", "schema": { "$ref": "#/components/schemas/datetime" }, "explode": false } ], "responses": { "200": { "description": "Response returned when listing enrollments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEnrollmentsResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } } }, "/enrollments/query-jobs": { "post": { "operationId": "create_sequence_enrollment_query_job", "description": "Start an asynchronous query job that exports sequence enrollments\nmatching the optional filter; omitting `filter` exports all enrollments.\nPoll the job until it is `FINISHED`, then page through the results.", "parameters": [], "responses": { "201": { "description": "Response returned when creating a Bulk API query job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBulkApiJobSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBulkApiSequenceEnrollmentsJobRequest" } } } }, "x-mcp-tool": { "destructiveHint": false, "openWorldHint": false } }, "get": { "operationId": "list_sequence_enrollment_query_jobs", "description": "List sequence enrollment query jobs, optionally filtered by status.", "parameters": [ { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor returned by the previous page.", "schema": { "type": "string" }, "explode": false }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "explode": false }, { "name": "status", "in": "query", "required": false, "description": "Filter jobs by status.", "schema": { "$ref": "#/components/schemas/BulkApiJobStatus" }, "explode": false } ], "responses": { "200": { "description": "Response returned when listing Bulk API jobs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBulkApiJobsSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } } }, "/enrollments/query-jobs/{job_id}": { "get": { "operationId": "get_sequence_enrollment_query_job", "description": "Get a query job's status. Poll until the status is terminal; results are\navailable once the job is `FINISHED`. Jobs expire 24 hours after\ncreation.", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response returned when fetching a Bulk API job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a Bulk API job cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobNotFoundResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } } }, "/enrollments/query-jobs/{job_id}/cancel": { "post": { "operationId": "cancel_sequence_enrollment_query_job", "description": "Cancel a query job. Only `IN_PROGRESS` jobs can be canceled.", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response returned when canceling a Bulk API job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelBulkApiJobSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a Bulk API job cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobNotFoundResponse" } } } }, "409": { "description": "Response returned when a Bulk API job is not cancelable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelBulkApiJobNotCancelableResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ] } }, "/enrollments/query-jobs/{job_id}/results": { "get": { "operationId": "get_sequence_enrollment_query_job_results", "description": "Get Bulk API job results. By default this returns JSON. Send\n`Accept: application/x-ndjson` to stream newline-delimited JSON.", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "explode": false }, { "name": "page_size", "in": "query", "required": false, "description": "Maximum is 2,000 for JSON responses and 10,000 when `Accept` is\n`application/x-ndjson`.", "schema": { "type": "integer", "minimum": 1, "maximum": 10000 }, "explode": false } ], "responses": { "200": { "description": "Successful response returned when fetching completed Bulk API job results.", "headers": { "x-total": { "required": false, "description": "Total result count. Present for NDJSON responses.", "schema": { "type": "integer" } }, "x-page": { "required": false, "description": "Result page number. Present for NDJSON responses.", "schema": { "type": "integer" } }, "x-page-size": { "required": false, "description": "Result page size. Present for NDJSON responses.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "total", "page", "page_size", "data" ], "properties": { "total": { "type": "integer" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollment" } } }, "description": "Successful response returned when fetching completed Bulk API job results." } }, "application/x-ndjson": { "schema": { "type": "string" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a Bulk API job cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobNotFoundResponse" } } } }, "409": { "description": "Response returned when Bulk API job results are not ready yet.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/GetBulkApiJobResultsNotReadyResponse" }, { "$ref": "#/components/schemas/GetBulkApiJobResultsFailedResponse" }, { "$ref": "#/components/schemas/GetBulkApiJobResultsCanceledResponse" } ] } } } }, "410": { "description": "Response returned when Bulk API job results have expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobResultsExpiredResponse" } } } }, "413": { "description": "Response returned when a requested Bulk API results page is too large.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkApiJobResultsPayloadTooLargeResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } } }, "/enrollments/{id}": { "get": { "operationId": "get_sequence_enrollment", "description": "Get a single enrollment by its ID.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "Response returned when fetching an enrollment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEnrollmentResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when an enrollment cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentNotFoundResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } }, "delete": { "operationId": "delete_sequence_enrollment", "description": "Cancel an enrollment, stopping any remaining steps for the person.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "Response returned when deleting an enrollment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteEnrollmentSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when an enrollment cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentNotFoundResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ], "x-mcp-tool": { "idempotentHint": true, "openWorldHint": false } } }, "/enrollments/{id}/pause": { "post": { "operationId": "pause_sequence_enrollment", "description": "Pause an enrollment, halting the person's progress through the sequence\nuntil it is resumed.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "Response returned when pausing an enrollment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PauseEnrollmentSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when an enrollment cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentNotFoundResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ], "x-mcp-tool": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false } } }, "/enrollments/{id}/resume": { "post": { "operationId": "resume_sequence_enrollment", "description": "Resume a paused enrollment so the person continues through the sequence.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "Response returned when resuming an enrollment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumeEnrollmentSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when an enrollment cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentNotFoundResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences", "Sequence Enrollments" ], "x-mcp-tool": { "destructiveHint": false, "idempotentHint": true } } }, "/sequences": { "get": { "operationId": "list_sequences", "description": "List sequences \u2014 automated series of outreach steps (emails, tasks, and\ntiming conditions) that run against enrolled people.", "parameters": [ { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor returned by the previous page.", "schema": { "type": "string" }, "explode": false }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "explode": false } ], "responses": { "200": { "description": "Response returned when listing sequences.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSequencesResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } } }, "/sequences/{id}": { "get": { "operationId": "retrieve_sequence", "description": "Get a single sequence by its ID, including its owner, send schedule, and\nruleset.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "Response returned when retrieving a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveSequenceResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a sequence cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SequenceNotFoundResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } }, "delete": { "operationId": "delete_sequence", "description": "Delete a sequence by its ID.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "Response returned when deleting a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSequenceSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a sequence cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SequenceNotFoundResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences" ], "x-mcp-tool": { "idempotentHint": true, "openWorldHint": false } } }, "/sequences/{id}/pause": { "post": { "operationId": "pause_sequence", "description": "Pause a sequence, halting progress for all of its enrollments until it\nis resumed.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "Response returned when pausing a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PauseSequenceSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a sequence cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SequenceNotFoundResponse" } } } }, "409": { "description": "Response returned when a sequence state change conflicts with a concurrent update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SequenceStateConflictResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences" ], "x-mcp-tool": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false } } }, "/sequences/{id}/resume": { "post": { "operationId": "resume_sequence", "description": "Resume a paused sequence so its enrollments continue.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "Response returned when resuming a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumeSequenceSuccessResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a sequence cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SequenceNotFoundResponse" } } } }, "409": { "description": "Response returned when a sequence state change conflicts with a concurrent update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SequenceStateConflictResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences" ], "x-mcp-tool": { "destructiveHint": false, "idempotentHint": true } } }, "/sequences/{id}/steps": { "get": { "operationId": "list_sequence_steps", "description": "List a sequence's steps. Steps are automatic emails, manual emails, or\ntasks (calls, LinkedIn touches, action items); each step's dependencies\ndescribe when it runs relative to its parent step.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor returned by the previous page.", "schema": { "type": "string" }, "explode": false }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "explode": false }, { "name": "type", "in": "query", "required": false, "description": "Repeat `type` to filter by multiple sequence step types.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceStepType" } } } ], "responses": { "200": { "description": "Response returned when listing sequence steps.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSequenceStepsResponse" } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a sequence step cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SequenceStepNotFoundResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } } }, "/sequences/{id}/steps/{step_id}": { "get": { "operationId": "retrieve_sequence_step", "description": "Get a single step of a sequence by ID. The response shape is\ndiscriminated by the step's `type`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "step_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "Response returned when retrieving an automatic email sequence step.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RetrieveAutomaticEmailSequenceStepResponse" }, { "$ref": "#/components/schemas/RetrieveManualEmailSequenceStepResponse" }, { "$ref": "#/components/schemas/RetrieveTaskSequenceStepResponse" } ] } } } }, "400": { "description": "Response for any operation that results in a bad request error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "bad_request" ] }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UResponses.BadRequestError" } }, "message": { "type": "string" } }, "description": "Response for any operation that results in a bad request error." } } } }, "401": { "description": "Response for any operation that results in an unauthorized error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an unauthorized error." } } } }, "404": { "description": "Response returned when a sequence step cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SequenceStepNotFoundResponse" } } } }, "429": { "description": "Response for any operation that exceeds a rate limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "rate_limited" ] }, "message": { "type": "string" } }, "description": "Response for any operation that exceeds a rate limit." } } } }, "500": { "description": "Response for any operation that results in an internal server error.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in an internal server error." } } } } }, "tags": [ "Sequences" ], "x-mcp-tool": { "readOnlyHint": true, "openWorldHint": false } } } }, "security": [ { "ApiKeyAuth": [] } ], "components": { "schemas": { "AutomaticEmailSequenceStep": { "type": "object", "required": [ "type", "config" ], "properties": { "type": { "type": "string", "enum": [ "AUTOMATIC_EMAIL" ] }, "config": { "$ref": "#/components/schemas/SequenceEmailStepConfig" } }, "allOf": [ { "$ref": "#/components/schemas/SequenceStepBase" } ], "description": "Representation of an automatic email sequence step." }, "AutomaticEnrollmentTaskAssignment": { "type": "string", "enum": [ "ASSIGN_TO_MAILBOX_OWNER", "ASSIGN_TO_USER" ], "description": "Assignment strategy for tasks created from automatic sequence enrollments." }, "BulkApiCommonQueryFilter": { "type": "object", "properties": { "updated_at": { "$ref": "#/components/schemas/BulkApiDatetimeRangeFilter" }, "sequence": { "$ref": "#/components/schemas/BulkApiUuidFilter" }, "person": { "$ref": "#/components/schemas/BulkApiUuidFilter" }, "company": { "$ref": "#/components/schemas/BulkApiUuidFilter" }, "mailbox": { "anyOf": [ { "$ref": "#/components/schemas/BulkApiMailboxIdFilter" }, { "$ref": "#/components/schemas/BulkApiMailboxEmailAddressFilter" } ] }, "started_at": { "$ref": "#/components/schemas/BulkApiDatetimeRangeFilter" }, "ended_at": { "$ref": "#/components/schemas/BulkApiDatetimeRangeFilter" }, "id": { "anyOf": [ { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "not_in": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "description": "Filter matching values included in a set." }, { "type": "object", "required": [ "not_in" ], "properties": { "in": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "not_in": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "description": "Filter matching values excluded from a set." } ] }, "is_blocked": { "type": "boolean" }, "is_bounced": { "type": "boolean" }, "is_canceled": { "type": "boolean" }, "is_opted_out": { "type": "boolean" }, "is_paused": { "type": "boolean" }, "is_replied": { "type": "boolean" } }, "description": "Filters shared by sequence enrollment and enrollment step Bulk API query jobs." }, "BulkApiDatetimeRangeFilter": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" } }, "description": "Datetime range filter. At least one bound must be provided. `gt` is mutually\nexclusive with `gte`, and `lt` is mutually exclusive with `lte`." }, "BulkApiJob": { "type": "object", "required": [ "job_id", "status", "total_rows", "error_code", "created_at", "expires_at", "canceled_at" ], "properties": { "job_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/BulkApiJobStatus" }, "total_rows": { "type": "integer", "nullable": true }, "error_code": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "canceled_at": { "type": "string", "nullable": true } }, "description": "Bulk API job representation." }, "BulkApiJobStatus": { "type": "string", "enum": [ "IN_PROGRESS", "FINISHED", "FAILED", "EXPIRED", "CANCELED" ], "description": "Status of an asynchronous Bulk API job." }, "BulkApiMailboxEmailAddressFilter": { "type": "object", "required": [ "email_address" ], "properties": { "id": { "type": "string" }, "email_address": { "type": "string" } }, "description": "Filter matching a mailbox by email address." }, "BulkApiMailboxIdFilter": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "email_address": { "type": "string" } }, "description": "Filter matching a mailbox by ID." }, "BulkApiUuidFilter": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } }, "description": "Filter matching a resource by ID." }, "CancelBulkApiJobNotCancelableResponse": { "type": "object", "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "job_not_cancelable" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a conflict error." } ], "description": "Response returned when a Bulk API job is not cancelable." }, "CancelBulkApiJobSuccessResponse": { "type": "object", "required": [ "job_id", "status" ], "properties": { "job_id": { "type": "string" }, "status": { "type": "string", "enum": [ "CANCELED" ] } }, "description": "Response returned when canceling a Bulk API job." }, "CreateBulkApiJobSuccessResponse": { "type": "object", "required": [ "job_id", "status", "expires_at" ], "properties": { "job_id": { "type": "string" }, "status": { "type": "string", "enum": [ "IN_PROGRESS" ] }, "expires_at": { "type": "string" } }, "description": "Response returned when creating a Bulk API query job." }, "CreateBulkApiSequenceEnrollmentStepsJobFilter": { "type": "object", "properties": { "status": { "anyOf": [ { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStepStatus" }, "minItems": 1 }, "not_in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStepStatus" }, "minItems": 1 } }, "description": "Filter matching values included in a set." }, { "type": "object", "required": [ "not_in" ], "properties": { "in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStepStatus" }, "minItems": 1 }, "not_in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStepStatus" }, "minItems": 1 } }, "description": "Filter matching values excluded from a set." } ] }, "enrollment": { "$ref": "#/components/schemas/BulkApiUuidFilter" }, "type": { "anyOf": [ { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStepType" }, "minItems": 1 }, "not_in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStepType" }, "minItems": 1 } }, "description": "Filter matching values included in a set." }, { "type": "object", "required": [ "not_in" ], "properties": { "in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStepType" }, "minItems": 1 }, "not_in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStepType" }, "minItems": 1 } }, "description": "Filter matching values excluded from a set." } ] }, "step_number": { "type": "integer", "minimum": 1 } }, "allOf": [ { "$ref": "#/components/schemas/BulkApiCommonQueryFilter" } ], "description": "Filters accepted when querying sequence enrollment steps." }, "CreateBulkApiSequenceEnrollmentStepsJobRequest": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/CreateBulkApiSequenceEnrollmentStepsJobFilter" } }, "description": "Request body for creating a sequence enrollment steps Bulk API query job." }, "CreateBulkApiSequenceEnrollmentsJobFilter": { "type": "object", "properties": { "status": { "anyOf": [ { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStatus" }, "minItems": 1 }, "not_in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStatus" }, "minItems": 1 } }, "description": "Filter matching values included in a set." }, { "type": "object", "required": [ "not_in" ], "properties": { "in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStatus" }, "minItems": 1 }, "not_in": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceEnrollmentStatus" }, "minItems": 1 } }, "description": "Filter matching values excluded from a set." } ] }, "enrolled_by_play": { "anyOf": [ { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "not_in": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "description": "Filter matching values included in a set." }, { "type": "object", "required": [ "not_in" ], "properties": { "in": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "not_in": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "description": "Filter matching values excluded from a set." } ], "description": "Filter by the play that created the enrollment." } }, "allOf": [ { "$ref": "#/components/schemas/BulkApiCommonQueryFilter" } ], "description": "Filters accepted when querying sequence enrollments." }, "CreateBulkApiSequenceEnrollmentsJobRequest": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/CreateBulkApiSequenceEnrollmentsJobFilter" } }, "description": "Request body for creating a sequence enrollments Bulk API query job." }, "CreateEnrollmentConflictResponse": { "type": "object", "required": [ "active_sequence_id", "active_enrollment_id" ], "properties": { "active_sequence_id": { "$ref": "#/components/schemas/uuid" }, "active_enrollment_id": { "$ref": "#/components/schemas/uuid" } }, "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "conflict" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a conflict error." } ], "description": "Response returned when the person is already enrolled in an active sequence." }, "CreateEnrollmentRequest": { "type": "object", "required": [ "sequence_id", "person_id", "mailbox_emails" ], "properties": { "sequence_id": { "$ref": "#/components/schemas/uuid" }, "person_id": { "$ref": "#/components/schemas/uuid" }, "mailbox_emails": { "type": "array", "items": { "$ref": "#/components/schemas/email" }, "minItems": 1, "maxItems": 10, "description": "Candidate mailbox addresses to send from. One is selected at enrollment\ntime. At most 10 addresses are accepted." } }, "description": "Request body for enrolling a person in a sequence." }, "CreateEnrollmentSuccessResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Enrollment" } ], "description": "Response returned when an enrollment is created." }, "DeleteEnrollmentSuccessResponse": { "type": "object", "required": [ "id", "is_canceled" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "is_canceled": { "type": "boolean", "enum": [ true ] } }, "description": "Response returned when deleting an enrollment." }, "DeleteSequenceSuccessResponse": { "type": "object", "required": [ "id", "is_deleted" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "is_deleted": { "type": "boolean", "enum": [ true ] } }, "description": "Response returned when deleting a sequence." }, "EmailSendDays": { "type": "object", "required": [ "1", "2", "3", "4", "5", "6", "7" ], "properties": { "1": { "type": "array", "items": { "$ref": "#/components/schemas/EmailSendWindow" }, "nullable": true }, "2": { "type": "array", "items": { "$ref": "#/components/schemas/EmailSendWindow" }, "nullable": true }, "3": { "type": "array", "items": { "$ref": "#/components/schemas/EmailSendWindow" }, "nullable": true }, "4": { "type": "array", "items": { "$ref": "#/components/schemas/EmailSendWindow" }, "nullable": true }, "5": { "type": "array", "items": { "$ref": "#/components/schemas/EmailSendWindow" }, "nullable": true }, "6": { "type": "array", "items": { "$ref": "#/components/schemas/EmailSendWindow" }, "nullable": true }, "7": { "type": "array", "items": { "$ref": "#/components/schemas/EmailSendWindow" }, "nullable": true } }, "description": "Mapping from ISO weekday number (Monday = 1, Sunday = 7) to send windows.\nA null value means sending is disabled for that day." }, "EmailSendScheduleRules": { "type": "object", "required": [ "time_zone", "send_days", "skip_us_holidays", "excluded_dates" ], "properties": { "time_zone": { "type": "string" }, "send_days": { "$ref": "#/components/schemas/EmailSendDays" }, "skip_us_holidays": { "type": "boolean" }, "excluded_dates": { "type": "array", "items": { "$ref": "#/components/schemas/ExcludedEmailSendDate" } } }, "description": "Sequence email send schedule rules." }, "EmailSendWindow": { "type": "object", "required": [ "start_time", "end_time" ], "properties": { "start_time": { "$ref": "#/components/schemas/EmailSendWindowTime" }, "end_time": { "$ref": "#/components/schemas/EmailSendWindowTime" } }, "description": "Time window during which sequence emails may be sent." }, "EmailSendWindowTime": { "type": "object", "required": [ "hour", "minute" ], "properties": { "hour": { "type": "integer", "minimum": 0, "maximum": 23 }, "minute": { "type": "integer", "minimum": 0, "maximum": 59 } }, "description": "Local wall-clock time used in a sequence email send window." }, "Enrollment": { "type": "object", "required": [ "id", "created_at", "updated_at", "sequence", "person", "mailbox", "enrolled_by_play", "reply_email_message", "status", "is_blocked", "is_bounced", "is_canceled", "is_excluded", "is_opted_out", "is_paused", "is_replied", "started_at", "ended_at" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "created_at": { "$ref": "#/components/schemas/datetime" }, "updated_at": { "$ref": "#/components/schemas/datetime" }, "sequence": { "$ref": "#/components/schemas/EnrollmentSequence" }, "person": { "$ref": "#/components/schemas/EnrollmentPerson" }, "mailbox": { "$ref": "#/components/schemas/EnrollmentMailbox" }, "enrolled_by_play": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EnrollmentPlay" } ], "nullable": true, "description": "The play that created the enrollment, if applicable." }, "reply_email_message": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/EnrollmentReplyEmailMessage" } ], "nullable": true }, "status": { "$ref": "#/components/schemas/SequenceEnrollmentStatus" }, "is_blocked": { "type": "boolean" }, "is_bounced": { "type": "boolean" }, "is_canceled": { "type": "boolean" }, "is_excluded": { "type": "boolean" }, "is_opted_out": { "type": "boolean" }, "is_paused": { "type": "boolean" }, "is_replied": { "type": "boolean" }, "started_at": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/datetime" } ], "nullable": true }, "ended_at": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/datetime" } ], "nullable": true } }, "description": "A sequence enrollment.", "example": { "id": "0b2f4c1a-6d3e-4f8b-9a2c-5e7d1f3a8b6c", "created_at": "2026-07-01T15:04:05Z", "updated_at": "2026-07-14T09:30:12Z", "sequence": { "id": "7f3a9b2c-1e4d-4a6f-8c5b-2d9e0f7a4b1c", "name": "Outbound \u2014 Warm Signups", "is_paused": false }, "person": { "id": "6741cc39-b332-45a8-a439-75b69db998b1", "email": "lead@example.com", "first_name": "Lee", "last_name": "Lead", "linkedin_url": null }, "mailbox": { "id": "9b2a2761-3cbe-481f-8a1e-b24859c674f8", "email": "rep@unifygtm.com", "display_name": "Sam Rep", "is_paused": false, "is_unauthorized": false }, "enrolled_by_play": { "id": "de885595-2d9a-4fb9-ae30-25ef18b6219b", "name": "New signup outreach" }, "reply_email_message": { "id": "1f3c0e2a-8b6d-4c2e-9f1a-2d4e6f8a0b1c", "subject": "Re: Quick question", "classifications": [ { "id": "4a8b6c0d-2e1f-4a3b-8c5d-9e7f1a2b3c4d", "category": "POSITIVE" } ], "received_at": "2026-07-14T09:30:12Z" }, "status": "FINISHED", "is_blocked": false, "is_bounced": false, "is_canceled": false, "is_excluded": false, "is_opted_out": false, "is_paused": false, "is_replied": true, "started_at": "2026-07-01T15:04:05Z", "ended_at": "2026-07-14T09:30:12Z" } }, "EnrollmentMailbox": { "type": "object", "required": [ "id", "email", "display_name", "is_paused", "is_unauthorized" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "email": { "$ref": "#/components/schemas/email" }, "display_name": { "type": "string", "nullable": true }, "is_paused": { "type": "boolean" }, "is_unauthorized": { "type": "boolean" } }, "description": "Mailbox details embedded in enrollment responses." }, "EnrollmentNotFoundResponse": { "type": "object", "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "not_found" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a not found error." } ], "description": "Response returned when an enrollment cannot be found." }, "EnrollmentPerson": { "type": "object", "required": [ "id", "email", "first_name", "last_name", "linkedin_url" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "email": { "$ref": "#/components/schemas/email" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "linkedin_url": { "type": "string", "nullable": true } }, "description": "Person details embedded in enrollment responses." }, "EnrollmentPlay": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "name": { "type": "string" } }, "description": "Details of the play that created an enrollment." }, "EnrollmentReplyEmailMessage": { "type": "object", "required": [ "received_at" ], "properties": { "received_at": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/datetime" } ], "nullable": true } }, "allOf": [ { "$ref": "#/components/schemas/ReplyEmailMessage" } ], "description": "Reply email message details embedded in enrollment responses." }, "EnrollmentSequence": { "type": "object", "required": [ "id", "name", "is_paused" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "name": { "type": "string" }, "is_paused": { "type": "boolean" } }, "description": "Sequence details embedded in enrollment responses." }, "ExcludedEmailSendDate": { "type": "object", "required": [ "date" ], "properties": { "date": { "$ref": "#/components/schemas/date" }, "should_recur": { "type": "boolean" } }, "description": "Custom date skipped by a sequence email send schedule." }, "GetBulkApiJobNotFoundResponse": { "type": "object", "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "not_found" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a not found error." } ], "description": "Response returned when a Bulk API job cannot be found." }, "GetBulkApiJobResultsCanceledResponse": { "type": "object", "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "results_canceled" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a conflict error." } ], "description": "Response returned when a Bulk API job was canceled and has no results." }, "GetBulkApiJobResultsExpiredResponse": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "results_expired" ] }, "message": { "type": "string" } }, "description": "Response returned when Bulk API job results have expired." }, "GetBulkApiJobResultsFailedResponse": { "type": "object", "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "results_failed" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a conflict error." } ], "description": "Response returned when a Bulk API job failed and has no results." }, "GetBulkApiJobResultsNotReadyResponse": { "type": "object", "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "results_not_ready" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a conflict error." } ], "description": "Response returned when Bulk API job results are not ready yet." }, "GetBulkApiJobResultsPayloadTooLargeResponse": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "results_page_too_large" ] }, "message": { "type": "string" } }, "description": "Response returned when a requested Bulk API results page is too large." }, "GetBulkApiJobSuccessResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BulkApiJob" } ], "description": "Response returned when fetching a Bulk API job." }, "GetEnrollmentResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Enrollment" } ], "description": "Response returned when fetching an enrollment." }, "ListBulkApiJobsSuccessResponse": { "type": "object", "required": [ "jobs", "next_cursor" ], "properties": { "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/BulkApiJob" } }, "next_cursor": { "type": "string", "nullable": true } }, "description": "Response returned when listing Bulk API jobs." }, "ListEnrollmentsResponse": { "type": "object", "required": [ "enrollments", "next_cursor" ], "properties": { "enrollments": { "type": "array", "items": { "$ref": "#/components/schemas/Enrollment" } }, "next_cursor": { "type": "string", "nullable": true } }, "description": "Response returned when listing enrollments." }, "ListSequenceStepsResponse": { "type": "object", "required": [ "steps", "next_cursor" ], "properties": { "steps": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceStep" } }, "next_cursor": { "type": "string", "nullable": true } }, "description": "Response returned when listing sequence steps." }, "ListSequencesResponse": { "type": "object", "required": [ "sequences", "next_cursor" ], "properties": { "sequences": { "type": "array", "items": { "$ref": "#/components/schemas/Sequence" } }, "next_cursor": { "type": "string", "nullable": true } }, "description": "Response returned when listing sequences." }, "ManualEmailSequenceStep": { "type": "object", "required": [ "type", "config" ], "properties": { "type": { "type": "string", "enum": [ "MANUAL_EMAIL" ] }, "config": { "$ref": "#/components/schemas/SequenceManualEmailStepConfig" } }, "allOf": [ { "$ref": "#/components/schemas/SequenceStepBase" } ], "description": "Representation of a manual email sequence step." }, "ManualEnrollmentTaskAssignment": { "type": "string", "enum": [ "ASSIGN_TO_ENROLLER", "ASSIGN_TO_MAILBOX_OWNER", "ASSIGN_TO_USER" ], "description": "Assignment strategy for tasks created from manual sequence enrollments." }, "PauseEnrollmentSuccessResponse": { "type": "object", "required": [ "id", "is_paused" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "is_paused": { "type": "boolean", "enum": [ true ] } }, "description": "Response returned when pausing an enrollment." }, "PauseSequenceSuccessResponse": { "type": "object", "required": [ "id", "is_paused" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "is_paused": { "type": "boolean", "enum": [ true ] } }, "description": "Response returned when pausing a sequence." }, "PlaySummary": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "description": "Play details embedded in sequence enrollment Bulk API results." }, "RelativeTimeUnit": { "type": "string", "enum": [ "MINUTE", "HOUR", "DAY", "WEEK" ], "description": "Time unit for relative task due dates." }, "ReplyEmailClassification": { "type": "object", "required": [ "id", "category" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "category": { "$ref": "#/components/schemas/ReplyEmailClassificationCategory" } }, "description": "Reply email classification details embedded in sequence API results." }, "ReplyEmailClassificationCategory": { "type": "string", "enum": [ "AUTOMATED", "NEGATIVE", "NEUTRAL", "POSITIVE" ], "description": "Reply classification category." }, "ReplyEmailMessage": { "type": "object", "required": [ "id", "subject", "classifications" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "subject": { "type": "string", "nullable": true }, "classifications": { "type": "array", "items": { "$ref": "#/components/schemas/ReplyEmailClassification" } } }, "description": "Reply email message details embedded in sequence API results." }, "ResumeEnrollmentSuccessResponse": { "type": "object", "required": [ "id", "is_paused" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "is_paused": { "type": "boolean", "enum": [ false ] } }, "description": "Response returned when resuming an enrollment." }, "ResumeSequenceSuccessResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Sequence" } ], "description": "Response returned when resuming a sequence." }, "RetrieveAutomaticEmailSequenceStepResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutomaticEmailSequenceStep" } ], "description": "Response returned when retrieving an automatic email sequence step." }, "RetrieveManualEmailSequenceStepResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ManualEmailSequenceStep" } ], "description": "Response returned when retrieving a manual email sequence step." }, "RetrieveSequenceResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Sequence" } ], "description": "Response returned when retrieving a sequence." }, "RetrieveTaskSequenceStepResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TaskSequenceStep" } ], "description": "Response returned when retrieving a manual task sequence step." }, "Sequence": { "type": "object", "required": [ "id", "created_at", "updated_at", "owner", "name", "is_paused", "send_schedule", "sequence_ruleset" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "created_at": { "$ref": "#/components/schemas/datetime" }, "updated_at": { "$ref": "#/components/schemas/datetime" }, "owner": { "$ref": "#/components/schemas/SequenceOwner" }, "name": { "type": "string" }, "is_paused": { "type": "boolean" }, "send_schedule": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SequenceSendSchedule" } ], "nullable": true }, "sequence_ruleset": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SequenceRuleset" } ], "nullable": true } }, "description": "A sequence." }, "SequenceCompany": { "type": "object", "required": [ "id", "name", "domain", "linkedin_url" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "domain": { "type": "string" }, "description": { "type": "string", "nullable": true, "description": "Present in enrollment results and omitted in step results." }, "linkedin_url": { "type": "string", "nullable": true } }, "description": "Company details embedded in sequence Bulk API results." }, "SequenceConditionType": { "type": "string", "enum": [ "AND", "OR", "TIMER" ], "description": "Sequence condition type used by sequence step dependencies." }, "SequenceEmailStepConfig": { "type": "object", "required": [ "is_root_message", "subject", "fallback_subject", "body", "cc_recipients", "bcc_recipients" ], "properties": { "is_root_message": { "type": "boolean" }, "subject": { "type": "string", "nullable": true }, "fallback_subject": { "type": "string", "nullable": true }, "body": { "type": "string" }, "cc_recipients": { "type": "array", "items": { "type": "string" } }, "bcc_recipients": { "type": "array", "items": { "type": "string" } } }, "description": "Configuration for automatic email sequence steps." }, "SequenceEnrollment": { "type": "object", "required": [ "id", "created_at", "updated_at", "status", "is_blocked", "is_bounced", "is_canceled", "is_excluded", "is_opted_out", "is_paused", "is_replied", "version", "started_at", "ended_at", "sequence", "mailbox", "person", "enrolled_by_play", "reply_email_message" ], "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "status": { "$ref": "#/components/schemas/SequenceEnrollmentStatus" }, "is_blocked": { "type": "boolean" }, "is_bounced": { "type": "boolean" }, "is_canceled": { "type": "boolean" }, "is_excluded": { "type": "boolean" }, "is_opted_out": { "type": "boolean" }, "is_paused": { "type": "boolean" }, "is_replied": { "type": "boolean" }, "version": { "type": "integer", "nullable": true }, "started_at": { "type": "string", "nullable": true }, "ended_at": { "type": "string", "nullable": true }, "sequence": { "$ref": "#/components/schemas/SequenceSummary" }, "mailbox": { "$ref": "#/components/schemas/SequenceMailbox" }, "person": { "$ref": "#/components/schemas/SequencePerson" }, "enrolled_by_play": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlaySummary" } ], "nullable": true, "description": "The play that created the enrollment, if applicable." }, "reply_email_message": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SequenceEnrollmentReplyEmailMessage" } ], "nullable": true } }, "description": "Sequence enrollment row returned by the sequence enrollments Bulk API." }, "SequenceEnrollmentReplyEmailMessage": { "type": "object", "required": [ "received_at" ], "properties": { "received_at": { "type": "string", "nullable": true } }, "allOf": [ { "$ref": "#/components/schemas/ReplyEmailMessage" } ], "description": "Reply email details embedded in sequence enrollment Bulk API results." }, "SequenceEnrollmentStatus": { "type": "string", "enum": [ "DRAFT", "IN_PROGRESS", "FINISHED" ], "description": "Status of a sequence enrollment." }, "SequenceEnrollmentStep": { "type": "object", "required": [ "id", "updated_at", "type", "status", "is_blocked", "is_bounced", "is_canceled", "is_opted_out", "is_paused", "is_replied", "sequence", "step_number", "started_at", "ended_at", "enrollment", "email_message", "reply_email_message" ], "properties": { "id": { "type": "string" }, "updated_at": { "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/SequenceEnrollmentStepType" } ], "nullable": true }, "status": { "$ref": "#/components/schemas/SequenceEnrollmentStepStatus" }, "is_blocked": { "type": "boolean" }, "is_bounced": { "type": "boolean" }, "is_canceled": { "type": "boolean" }, "is_opted_out": { "type": "boolean" }, "is_paused": { "type": "boolean" }, "is_replied": { "type": "boolean" }, "sequence": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "is_paused": { "type": "boolean" }, "version": { "type": "integer", "nullable": true } }, "required": [ "id", "name", "is_paused", "version" ] }, "step_number": { "type": "integer", "nullable": true, "minimum": 1, "description": "1-indexed position of this step within the sequence enrollment. Null while\na step execution exists but has not yet been assigned a position \u2014 for\nsequences with branching, the position is only fixed once a step is\nexpected to run or has finished." }, "started_at": { "type": "string", "nullable": true }, "ended_at": { "type": "string", "nullable": true }, "enrollment": { "$ref": "#/components/schemas/SequenceEnrollmentSummary" }, "email_message": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SequenceEnrollmentStepEmailMessage" } ], "nullable": true }, "reply_email_message": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ReplyEmailMessage" } ], "nullable": true } }, "description": "Sequence enrollment step row returned by the sequence enrollment steps Bulk API." }, "SequenceEnrollmentStepEmailMessage": { "type": "object", "required": [ "id", "subject", "sent_at", "from_email_address", "is_bounced", "is_opted_out", "clicks", "opens" ], "properties": { "id": { "type": "string" }, "subject": { "type": "string", "nullable": true }, "sent_at": { "type": "string", "nullable": true }, "from_email_address": { "type": "string", "nullable": true }, "is_bounced": { "type": "boolean" }, "is_opted_out": { "type": "boolean" }, "clicks": { "type": "integer", "minimum": 0 }, "opens": { "type": "integer", "minimum": 0 } }, "description": "Sent email message details embedded in sequence enrollment step Bulk API results." }, "SequenceEnrollmentStepStatus": { "type": "string", "enum": [ "NOT_STARTED", "SCHEDULED", "PENDING", "FINISHED", "CANCELED", "ERRORED", "UNREACHABLE" ], "description": "Status of an individual sequence enrollment step." }, "SequenceEnrollmentStepType": { "type": "string", "enum": [ "AUTOMATIC_EMAIL", "MANUAL_EMAIL", "ACTION_ITEM", "ZAPIER", "PHONE_CALL", "MANUAL_LINKEDIN_PROFILE_VIEW", "MANUAL_LINKEDIN_CONNECTION", "MANUAL_LINKEDIN_MESSAGE" ], "description": "Type of a sequence enrollment step." }, "SequenceEnrollmentSummary": { "type": "object", "required": [ "id", "mailbox", "person" ], "properties": { "id": { "type": "string" }, "mailbox": { "$ref": "#/components/schemas/SequenceMailbox" }, "person": { "$ref": "#/components/schemas/SequencePerson" } }, "description": "Enrollment details embedded in sequence enrollment step Bulk API results." }, "SequenceMailbox": { "type": "object", "required": [ "id", "email_address", "forward_to_email_address", "secondary_forward_to_email_address", "display_name", "is_paused", "is_unauthorized", "user", "secondary_forward_to_user" ], "properties": { "id": { "type": "string" }, "email_address": { "type": "string", "nullable": true }, "forward_to_email_address": { "type": "string", "nullable": true }, "secondary_forward_to_email_address": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "is_paused": { "type": "boolean" }, "is_unauthorized": { "type": "boolean" }, "user": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SequenceUser" } ], "nullable": true }, "secondary_forward_to_user": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SequenceUser" } ], "nullable": true } }, "description": "Mailbox details embedded in sequence Bulk API results." }, "SequenceManualEmailStepConfig": { "type": "object", "required": [ "task_priority", "auto_skip_on_due_date", "relative_due_at" ], "properties": { "task_priority": { "$ref": "#/components/schemas/TaskPriority" }, "auto_skip_on_due_date": { "type": "boolean" }, "relative_due_at": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SequenceStepRelativeDueAt" } ], "nullable": true } }, "allOf": [ { "$ref": "#/components/schemas/SequenceEmailStepConfig" } ], "description": "Configuration for manual email sequence steps." }, "SequenceNotFoundResponse": { "type": "object", "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "not_found" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a not found error." } ], "description": "Response returned when a sequence cannot be found." }, "SequenceOwner": { "type": "object", "required": [ "id", "email", "first_name", "last_name" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "email": { "$ref": "#/components/schemas/email" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true } }, "description": "Owner details embedded in sequence responses." }, "SequencePerson": { "type": "object", "required": [ "id", "email", "first_name", "last_name", "linkedin_url", "company" ], "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "linkedin_url": { "type": "string", "nullable": true }, "company": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SequenceCompany" } ], "nullable": true } }, "description": "Person details embedded in sequence Bulk API results." }, "SequenceRuleset": { "type": "object", "required": [ "id", "created_at", "updated_at", "name", "is_default", "automatic_enrollment_task_assignment", "automatic_enrollment_task_assignment_user_id", "manual_enrollment_task_assignment", "manual_enrollment_task_assignment_user_id", "opt_out_message", "allow_same_sequence_reenrollment", "block_reenrollment_value", "block_reenrollment_units" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "created_at": { "$ref": "#/components/schemas/datetime" }, "updated_at": { "$ref": "#/components/schemas/datetime" }, "name": { "type": "string" }, "is_default": { "type": "boolean" }, "automatic_enrollment_task_assignment": { "$ref": "#/components/schemas/AutomaticEnrollmentTaskAssignment" }, "automatic_enrollment_task_assignment_user_id": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/uuid" } ], "nullable": true }, "manual_enrollment_task_assignment": { "$ref": "#/components/schemas/ManualEnrollmentTaskAssignment" }, "manual_enrollment_task_assignment_user_id": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/uuid" } ], "nullable": true }, "opt_out_message": { "type": "string", "nullable": true }, "allow_same_sequence_reenrollment": { "type": "boolean" }, "block_reenrollment_value": { "type": "integer", "nullable": true }, "block_reenrollment_units": { "allOf": [ { "$ref": "#/components/schemas/UnitOfTime" } ], "nullable": true } }, "description": "Sequence ruleset embedded in sequence responses." }, "SequenceSendSchedule": { "type": "object", "required": [ "id", "created_at", "updated_at", "is_default", "name", "rules" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "created_at": { "$ref": "#/components/schemas/datetime" }, "updated_at": { "$ref": "#/components/schemas/datetime" }, "is_default": { "type": "boolean" }, "name": { "type": "string" }, "rules": { "$ref": "#/components/schemas/EmailSendScheduleRules" } }, "description": "Email send schedule embedded in sequence responses." }, "SequenceStateConflictResponse": { "type": "object", "required": [ "current_is_paused" ], "properties": { "current_is_paused": { "type": "boolean" } }, "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "state_conflict" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a conflict error." } ], "description": "Response returned when a sequence state change conflicts with a concurrent update." }, "SequenceStep": { "anyOf": [ { "$ref": "#/components/schemas/AutomaticEmailSequenceStep" }, { "$ref": "#/components/schemas/ManualEmailSequenceStep" }, { "$ref": "#/components/schemas/TaskSequenceStep" } ], "description": "A sequence step in any of its variants." }, "SequenceStepAndCondition": { "type": "object", "required": [ "type", "subconditions" ], "properties": { "type": { "type": "string", "enum": [ "AND" ] }, "subconditions": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceStepCondition" } } }, "description": "Conjunction condition embedded in sequence step responses." }, "SequenceStepBase": { "type": "object", "required": [ "id", "key", "created_at", "updated_at", "sequence_id", "version_number", "dependencies" ], "properties": { "id": { "$ref": "#/components/schemas/uuid" }, "key": { "type": "string" }, "created_at": { "$ref": "#/components/schemas/datetime" }, "updated_at": { "$ref": "#/components/schemas/datetime" }, "sequence_id": { "$ref": "#/components/schemas/uuid" }, "version_number": { "type": "integer", "nullable": true, "minimum": 1 }, "dependencies": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceStepDependency" } } }, "description": "Shared fields for sequence step responses." }, "SequenceStepCondition": { "anyOf": [ { "$ref": "#/components/schemas/SequenceStepTimerCondition" }, { "$ref": "#/components/schemas/SequenceStepAndCondition" }, { "$ref": "#/components/schemas/SequenceStepOrCondition" } ], "description": "Condition embedded in sequence step responses." }, "SequenceStepDependency": { "type": "object", "required": [ "parent_step_id", "condition" ], "properties": { "parent_step_id": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/uuid" } ], "nullable": true }, "condition": { "allOf": [ { "$ref": "#/components/schemas/SequenceStepCondition" } ], "nullable": true } }, "description": "Dependency edge embedded in sequence step responses." }, "SequenceStepNotFoundResponse": { "type": "object", "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "not_found" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a not found error." } ], "description": "Response returned when a sequence step cannot be found." }, "SequenceStepOrCondition": { "type": "object", "required": [ "type", "subconditions" ], "properties": { "type": { "type": "string", "enum": [ "OR" ] }, "subconditions": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceStepCondition" } } }, "description": "Disjunction condition embedded in sequence step responses." }, "SequenceStepRelativeDueAt": { "type": "object", "required": [ "num_units_of_time", "unit_of_time" ], "properties": { "num_units_of_time": { "type": "number", "minimum": 0 }, "unit_of_time": { "$ref": "#/components/schemas/RelativeTimeUnit" } }, "description": "Relative due date for tasks created by manual sequence steps." }, "SequenceStepTimerCondition": { "type": "object", "required": [ "type", "duration_value", "duration_unit" ], "properties": { "type": { "type": "string", "enum": [ "TIMER" ] }, "duration_value": { "type": "integer", "nullable": true }, "duration_unit": { "$ref": "#/components/schemas/SequenceTimerConditionDurationUnit" } }, "description": "Timer condition embedded in sequence step responses." }, "SequenceStepType": { "type": "string", "enum": [ "AUTOMATIC_EMAIL", "MANUAL_EMAIL", "ACTION_ITEM", "PHONE_CALL", "MANUAL_LINKEDIN_PROFILE_VIEW", "MANUAL_LINKEDIN_CONNECTION", "MANUAL_LINKEDIN_MESSAGE" ], "description": "Type of a sequence step." }, "SequenceSummary": { "type": "object", "required": [ "id", "name", "is_paused" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "is_paused": { "type": "boolean" } }, "description": "Minimal sequence details embedded in sequence enrollment Bulk API results." }, "SequenceTaskScheduleStepConfig": { "type": "object", "required": [ "task_priority", "auto_skip_on_due_date", "relative_due_at" ], "properties": { "task_priority": { "$ref": "#/components/schemas/TaskPriority" }, "auto_skip_on_due_date": { "type": "boolean" }, "relative_due_at": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SequenceStepRelativeDueAt" } ], "nullable": true } }, "description": "Schedule configuration shared by manual sequence steps that create tasks." }, "SequenceTaskStepConfig": { "type": "object", "required": [ "note_content" ], "properties": { "note_content": { "type": "string", "nullable": true } }, "allOf": [ { "$ref": "#/components/schemas/SequenceTaskScheduleStepConfig" } ], "description": "Configuration for manual task sequence steps." }, "SequenceTimerConditionDurationUnit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days", "weeks" ], "description": "Duration unit used by timer conditions." }, "SequenceUser": { "type": "object", "required": [ "id", "email", "first_name", "last_name" ], "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true } }, "description": "User details embedded in sequence Bulk API results." }, "TaskPriority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "URGENT" ], "description": "Priority assigned to tasks created by manual sequence steps." }, "TaskSequenceStep": { "type": "object", "required": [ "type", "config" ], "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "ACTION_ITEM" ] }, { "type": "string", "enum": [ "PHONE_CALL" ] }, { "type": "string", "enum": [ "MANUAL_LINKEDIN_CONNECTION" ] }, { "type": "string", "enum": [ "MANUAL_LINKEDIN_MESSAGE" ] }, { "type": "string", "enum": [ "MANUAL_LINKEDIN_PROFILE_VIEW" ] } ] }, "config": { "$ref": "#/components/schemas/SequenceTaskStepConfig" } }, "allOf": [ { "$ref": "#/components/schemas/SequenceStepBase" } ], "description": "Representation of a manual task sequence step." }, "UResponses.BadRequestError": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, "object_api_name": { "type": "string" }, "attribute_api_name": { "type": "string" } }, "allOf": [ { "type": "object", "additionalProperties": {} } ], "description": "Validation error detail returned for bad request responses." }, "UnifyApi.Data.CreateBulkApiObjectRecordsJobObjectNotFoundResponse": { "type": "object", "allOf": [ { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "not_found" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in a not found error." } ], "description": "Response returned when the object being queried cannot be found." }, "UnitOfTime": { "type": "string", "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ], "description": "Unit used for sequence reenrollment blocking windows." }, "date": { "type": "string", "format": "date", "description": "String value representing an RFC 3339 full date." }, "datetime": { "type": "string", "format": "date-time", "description": "String value representing an RFC 3339 datetime." }, "email": { "type": "string", "format": "email", "description": "String value representing an email address." }, "uuid": { "type": "string", "format": "uuid", "description": "String UUID value." } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key" } } }, "servers": [ { "url": "https://api.unifygtm.com/sequences/v1", "variables": {} } ] }