# Create Sequence enrollments

> Source: https://truto.one/docs/api-reference/unified-crm-api/sequenceenrollments/create/

`POST /unified/crm/sequence_enrollments`

Resource: **SequenceEnrollments** · API: **Unified CRM API**

## Supported integrations

Apollo

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  The format of the response. - `unified` returns the response with unified mappings applied. - `raw` returns the unprocessed, raw response from the remote API. - `normalized` applies the unified mappings and returns the data in a normalized format. - `stream` returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory. - `debug` returns the final unified result alongside raw remote fetch information. The response is an envelope containing `result` (identical to unified mode output) and `debug` (with `requestUrl`, `requestOptions`, `data`, `responseHeaders`, and for list operations: `nextCursor`, `isLooping`, `isEmptyResult`, `resultCount`). When the upstream body exceeds 1 MiB, `data` is replaced by `{ truto_truncated: true, truto_max_bytes, truto_excerpt }`. `debug` is `null` for static responses or when `truto_skip_api_call=true`. An integrated account token that cannot read credentials (the kind the connect flow gives a browser) gets a `403` for `debug`. Defaults to `unified`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_enforce_write_schema`** _(boolean)_
  Validates the request body against this method's `request_body_schema` before the request is sent to the underlying integration. When a field marked `required` is missing, Truto responds `400` with the missing field names under `truto_error_insight.missing_required_body_fields` instead of forwarding the call. Only the fields documented in `request_body_schema` are checked. A body carrying a non-empty `remote_data` object is forwarded unchecked, because `remote_data` is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under `truto_error_insight.conditionally_required_body_fields` rather than rejected. Some integrations declare fields `required` on `update` that the provider only requires on `create`; check `meta/{method}` for the resource before enabling this on update calls. If you sent an `Idempotency-Key` and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to `false`, which forwards the request as-is.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.

## Request body

- **`sequence`** _(object)_
  The sequence to enroll the contact in.
  - **`id`** _(string, required)_
    The unique identifier
- **`contact`** _(object)_
  The contact to enroll (an Apollo contact ID).
  - **`id`** _(string, required)_
    The unique identifier
- **`mailbox`** _(object)_
  The mailbox that sends the sequence's emails (see mailboxes list). Apollo requires it.
  - **`id`** _(string, required)_
    The unique identifier
  - **`email`** _(string)_
    Optional: a specific address of that mailbox to send from.
- **`user`** _(object)_
  Optional: the Apollo user shown as the one who enrolled the contact.
  - **`id`** _(string)_
- **`status`** _(string)_
  paused adds the contact without starting; combine with start_at to start later.
  Allowed: `active`, `paused`, `finished`, `bounced`, `failed`, `skipped`, `other`, `active`, `paused`
- **`start_at`** _(string)_
  When a paused enrollment starts automatically (ISO 8601). Only used with status paused.
- **`add_without_email`** _(boolean)_
  Enroll even if the contact has no email. Off by default.
- **`add_unverified_email`** _(boolean)_
  Enroll even if the contact's email is unverified. Off by default.
- **`add_after_job_change`** _(boolean)_
  Enroll even if the contact recently changed jobs. Off by default.
- **`add_if_active_in_other_sequences`** _(boolean)_
  Enroll even if the contact is in another sequence. Off by default.
- **`add_if_finished_other_sequences`** _(boolean)_
  Enroll even if the contact finished another sequence. Off by default.
- **`add_if_company_in_sequence`** _(boolean)_
  Enroll even if someone from the contact's company is already in this sequence. Off by default.
- **`remote_data`** _(object)_
  Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

## Response body

- **`id`** _(string, required)_
  The enrollment's unique identifier
- **`sequence`** _(object)_
  The sequence the contact is enrolled in
  - **`id`** _(string)_
    The unique identifier
- **`contact`** _(object)_
  The enrolled contact
  - **`id`** _(string)_
    The unique identifier
- **`mailbox`** _(object)_
  The mailbox that sends the sequence's emails to this contact
  - **`id`** _(string)_
    The unique identifier
  - **`email`** _(string)_
    The mailbox's email address
- **`status`** _(string)_
  The enrollment's status. `skipped` means the contact was not enrolled; see skip_reason.
  Allowed: `active`, `paused`, `finished`, `bounced`, `failed`, `skipped`, `other`
- **`skip_reason`** _(string)_
  Why the contact was not enrolled, when status is skipped
- **`created_at`** _(string)_
  The date and time the contact was enrolled
- **`remote_data`** _(object)_
  Raw data returned from the remote API call.

## Code examples

### Truto CLI

```bash
truto unified crm sequenceenrollments \
  -m create \
  -a '<integrated_account_id>' \
  -b '{
  "sequence": {},
  "contact": {},
  "mailbox": {},
  "user": {},
  "status": "active",
  "start_at": "your_start_at",
  "add_without_email": true,
  "add_unverified_email": true,
  "add_after_job_change": true,
  "add_if_active_in_other_sequences": true,
  "add_if_finished_other_sequences": true,
  "add_if_company_in_sequence": true,
  "remote_data": {}
}' \
  -o json
```

### Truto TS SDK

```typescript
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.create(
  'crm',
  'sequenceenrollments',
  {
  "sequence": {},
  "contact": {},
  "mailbox": {},
  "user": {},
  "status": "active",
  "start_at": "your_start_at",
  "add_without_email": true,
  "add_unverified_email": true,
  "add_after_job_change": true,
  "add_if_active_in_other_sequences": true,
  "add_if_finished_other_sequences": true,
  "add_if_company_in_sequence": true,
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
```

### Truto Python SDK

```python
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.create(
        "crm",
        "sequenceenrollments",
        {
        "sequence": {},
        "contact": {},
        "mailbox": {},
        "user": {},
        "status": "active",
        "start_at": "your_start_at",
        "add_without_email": True,
        "add_unverified_email": True,
        "add_after_job_change": True,
        "add_if_active_in_other_sequences": True,
        "add_if_finished_other_sequences": True,
        "add_if_company_in_sequence": True,
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
```

### curl

```bash
curl -X POST 'https://api.truto.one/unified/crm/sequence_enrollments?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "sequence": {},
  "contact": {},
  "mailbox": {},
  "user": {},
  "status": "active",
  "start_at": "your_start_at",
  "add_without_email": true,
  "add_unverified_email": true,
  "add_after_job_change": true,
  "add_if_active_in_other_sequences": true,
  "add_if_finished_other_sequences": true,
  "add_if_company_in_sequence": true,
  "remote_data": {}
}'
```

### JavaScript

```javascript
const integratedAccountId = '<integrated_account_id>';

const body = {
  "sequence": {},
  "contact": {},
  "mailbox": {},
  "user": {},
  "status": "active",
  "start_at": "your_start_at",
  "add_without_email": true,
  "add_unverified_email": true,
  "add_after_job_change": true,
  "add_if_active_in_other_sequences": true,
  "add_if_finished_other_sequences": true,
  "add_if_company_in_sequence": true,
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/crm/sequence_enrollments?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

url = "https://api.truto.one/unified/crm/sequence_enrollments"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "sequence": {},
    "contact": {},
    "mailbox": {},
    "user": {},
    "status": "active",
    "start_at": "your_start_at",
    "add_without_email": True,
    "add_unverified_email": True,
    "add_after_job_change": True,
    "add_if_active_in_other_sequences": True,
    "add_if_finished_other_sequences": True,
    "add_if_company_in_sequence": True,
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())
```