> ## Documentation Index > Fetch the complete documentation index at: https://docs.blujay.io/llms.txt > Use this file to discover all available pages before exploring further. # Enroll a contact in a workflow > Starts a manual workflow for one contact. `request_id` is required and makes retries safe: sending the same `request_id` again returns `200` with the original result instead of enrolling the contact twice. A `200` can also mean no new run started; `enrollment_status` and `no_op_reason` say what happened. `metadata` is optional context about the enrollment. It isn't available as workflow variables. Returns `409 WORKFLOW_LIFECYCLE_ERROR` when the workflow isn't active or doesn't start manually, and `422 WORKFLOW_VALIDATION_ERROR` when the workflow can't run yet, for example because it has no published version. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v1/workflows/{workflow_id}/enrollments openapi: 3.1.0 info: title: Blujay API version: 1.0.0 description: >- The Blujay API lets you send and receive iMessage, RCS and SMS messages from your Blujay phone numbers, manage contacts, and receive real-time webhooks. Every response uses the same JSON envelope and carries a `trace_id` you can share with support. Authenticate with your workspace API key. servers: - url: https://api.blujay.io description: Production security: - PublicApiKey: [] tags: - name: Auth description: Check which workspace and credential a request is using. - name: Chats description: >- Direct and group conversations between your Blujay numbers and your contacts. - name: Messages description: Send, read, edit, unsend and retry messages. - name: Phone Numbers description: >- Your Blujay numbers, whether each can send right now, and their live sending limits. - name: Capability description: >- Check whether a phone number can be reached by iMessage, RCS or SMS before you send. - name: Contacts description: Create, find, update, tag, assign and opt out contacts. - name: vCards description: >- Saved contact cards that you can send in a message. Recipients get a native contact card over iMessage, SMS or RCS. - name: Team Members description: People in your workspace you can assign contacts to. - name: Workflows description: Enroll contacts in workflows you start manually. - name: Attachments description: >- Upload files once and reuse them in messages, or download files from messages. - name: Webhooks description: Subscribe to events, inspect delivery attempts and verify signatures. paths: /v1/workflows/{workflow_id}/enrollments: post: tags: - Workflows summary: Enroll a contact in a workflow description: > Starts a manual workflow for one contact. `request_id` is required and makes retries safe: sending the same `request_id` again returns `200` with the original result instead of enrolling the contact twice. A `200` can also mean no new run started; `enrollment_status` and `no_op_reason` say what happened. `metadata` is optional context about the enrollment. It isn't available as workflow variables. Returns `409 WORKFLOW_LIFECYCLE_ERROR` when the workflow isn't active or doesn't start manually, and `422 WORKFLOW_VALIDATION_ERROR` when the workflow can't run yet, for example because it has no published version. operationId: triggerPublicWorkflow parameters: - $ref: '#/components/parameters/WorkflowId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePublicWorkflowTriggerRequest' examples: enrollContact: summary: Enroll a contact with context value: contact_id: contact_abc123 request_id: signup-7f1d9d0a8a3d4b4d metadata: source: signup_form external_id: A-1042 responses: '200': description: >- This `request_id` was already used, or no new run started. Check `enrollment_status` and `no_op_reason`. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object required: - data properties: data: $ref: '#/components/schemas/PublicWorkflowTrigger' '201': description: The contact was enrolled and a workflow run started. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object required: - data properties: data: $ref: '#/components/schemas/PublicWorkflowTrigger' '400': $ref: '#/components/responses/ValidationError' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '422': $ref: '#/components/responses/WorkflowValidationError' security: - PublicApiKey: [] components: parameters: WorkflowId: name: workflow_id in: path required: true schema: $ref: '#/components/schemas/WorkflowId' schemas: CreatePublicWorkflowTriggerRequest: type: object additionalProperties: false required: - contact_id - request_id properties: contact_id: $ref: '#/components/schemas/ContactId' request_id: type: string examples: - enroll-order-4821 minLength: 1 maxLength: 200 description: >- Your unique ID for this enrollment. Sending the same `request_id` again returns the original result instead of enrolling the contact twice. metadata: $ref: '#/components/schemas/WorkflowMetadata' SuccessEnvelope: type: object description: Wraps every successful response. The result is in `data`. required: - status - trace_id - timestamp properties: status: type: string enum: - success trace_id: $ref: '#/components/schemas/TraceId' timestamp: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time client_request_id: type: string description: >- Your `X-Request-ID` header value, echoed back when you send one. Not included on the send responses (`POST /v1/chats`, `POST /v1/chats/{chat_id}/messages`, `POST /v1/messages/{message_id}/retry`); keep your own mapping from your request ID to the returned message ID there. PublicWorkflowTrigger: type: object additionalProperties: false required: - workflow_id - contact_id - request_id - enrollment_status - workflow_run properties: workflow_id: $ref: '#/components/schemas/WorkflowId' contact_id: $ref: '#/components/schemas/ContactId' request_id: type: string examples: - enroll-order-4821 enrollment_status: type: string no_op_reason: type: string description: >- Why no new run started, for example `contact_opted_out` or `duplicate_non_terminal_run`. workflow_run: oneOf: - $ref: '#/components/schemas/PublicWorkflowRunSummary' - type: 'null' WorkflowId: type: string examples: - workflow_abc123 pattern: ^workflow_[A-Za-z0-9_-]+$ ContactId: type: string examples: - contact_abc123 pattern: ^contact_[A-Za-z0-9_-]+$ WorkflowMetadata: type: object additionalProperties: oneOf: - type: string maxLength: 500 - type: number - type: boolean - type: 'null' maxProperties: 20 description: >- Optional context about the enrollment. Up to 20 keys, each a string (up to 500 characters), number, boolean or null, and 4,096 bytes in total. TraceId: type: string examples: - trc_8f2a1c0e4b7d pattern: ^trc_[A-Za-z0-9_-]+$ PublicWorkflowRunSummary: type: object additionalProperties: false required: - status properties: status: type: string status_reason_code: type: string description: >- Why the run has its status, for example `contact_opted_out`, `workflow_disabled`, `phone_number_unavailable`, `workflow_interrupted`, `unsupported_workflow_step` or `internal_error`. ErrorEnvelope: type: object description: >- Wraps every error response. Branch on `error.code`, and include `trace_id` when you contact support. required: - status - error - trace_id - timestamp properties: status: const: error error: $ref: '#/components/schemas/PublicError' trace_id: $ref: '#/components/schemas/TraceId' timestamp: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time client_request_id: type: string description: Your `X-Request-ID` header value, echoed back when you send one. PublicError: type: object required: - code - message - type - http_status - retryable - doc_url - details properties: code: type: string description: Stable, machine-readable error code. Branch on this value. examples: - RATE_LIMIT_EXCEEDED - QUEUE_UNAVAILABLE - FEATURE_NOT_ENABLED message: type: string description: Human-readable explanation. It can change, so don't parse it. type: type: string description: Broad error category. examples: - validation - auth - idempotency - rate_limit - queue - feature_gate http_status: type: integer description: The HTTP status code of the response. enum: - 400 - 401 - 403 - 404 - 409 - 413 - 415 - 422 - 429 - 500 - 502 - 503 retryable: type: boolean description: Whether sending the same request again later can succeed. doc_url: type: string format: uri description: Link to documentation for this error code. details: type: array description: >- Extra structured context, such as the fields that failed validation or the limit you hit. items: type: object additionalProperties: true retry_after: type: integer minimum: 1 description: >- Seconds to wait before retrying. Also sent as the `Retry-After` header. reset_at: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time description: When the limit you hit resets. headers: XTraceID: description: >- Unique ID for this request. It matches `trace_id` in the body. Include it when you contact Blujay support. schema: $ref: '#/components/schemas/TraceId' responses: ValidationError: description: The request is invalid. `details` lists the fields that failed. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: invalidInput: value: status: error error: code: VALIDATION_ERROR message: Request validation failed type: validation http_status: 400 retryable: false doc_url: https://docs.blujay.io/errors/validation-error details: [] trace_id: trc_8f2a1c0e4b7d timestamp: '2026-10-14T00:00:00.000Z' NotFound: description: The resource doesn't exist or isn't in your workspace. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Conflict: description: >- The workflow can't accept enrollments in its current state (`WORKFLOW_LIFECYCLE_ERROR`). It isn't active, or it doesn't start manually. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: workflowNotActive: value: status: error error: code: WORKFLOW_LIFECYCLE_ERROR message: >- Workflow must be active before it can accept manual enrollment type: validation http_status: 409 retryable: false doc_url: https://docs.blujay.io/errors/workflow-lifecycle-error details: [] trace_id: trc_8f2a1c0e4b7d timestamp: '2026-10-14T00:00:00.000Z' WorkflowValidationError: description: >- The workflow can't run this enrollment (`WORKFLOW_VALIDATION_ERROR`), for example because it has no published version. `error.message` says why. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: workflowNotPublished: value: status: error error: code: WORKFLOW_VALIDATION_ERROR message: >- Workflow requires a published version before it can accept manual enrollment type: validation http_status: 422 retryable: false doc_url: https://docs.blujay.io/errors/workflow-validation-error details: [] trace_id: trc_8f2a1c0e4b7d timestamp: '2026-10-14T00:00:00.000Z' securitySchemes: PublicApiKey: type: http scheme: bearer bearerFormat: blu_... description: > Your workspace API key, sent as `Authorization: Bearer blu_...`. Workspace admins can find it in the Blujay app under **API**. An API key has full access to your workspace and works on every endpoint. There is no test mode: every key sends real messages and changes real data, so keep it secret and use it only from your server. Each API key can make 600 read requests and 120 write requests per minute, plus 60 attachment requests per minute. Over a limit you get `429 RATE_LIMIT_EXCEEDED` with `Retry-After`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.