Documentation Index

Fetch the complete documentation index at: https://resend.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

This step adds the current contact to a specified Segment when reached in the Automation flow. Common use cases:

• Cohorts — Add contacts to a cohort segment after a specific event.
• Lifecycle — Segment contacts as they progress through onboarding.
• Engagement — Group contacts who completed a specific action.

[​

](#how-it-works)

How it works

Using the dashboard

Define a Add to segment step and select the segment from the dropdown.

Using the API

The add_to_segment step accepts a single segment_id field.

[​

](#configuration)

Configuration

[​

](#param-config-segment-id)

config.segment_id

string

required

The ID of the segment to add the contact to.

Example

{
  "key": "add_to_vip",
  "type": "add_to_segment",
  "config": {
    "segment_id": "83a1e324-26dc-47eb-9b28-ba8b6d1fe808"
  }
}