# Attentive

> Grow and work with your Attentive text and email audience: subscribe and unsubscribe people, keep their details and custom attributes up to date, send custom and shopping events that start Journeys, manage segments and your product catalog, and start workflows when people subscribe, reply, click or open.

App · 22 actions. Web page: https://docs.lodol.com/docs/integrations/attentive

## Actions

### Add people to segment

Add up to 10,000 people to a segment by email, phone or your user ID. Attentive does it in the background; 'Get bulk job' shows when it is done.

**Inputs**

- Segment (`segment_external_id`, text, required): The segment. Pick one, or give its external ID from an earlier step.
- Emails (`emails`, list): Email addresses, as a list or separated by commas.
- Phone numbers (`phones`, list): Phone numbers in international format, such as +15555555555, as a list or separated by commas.
- Your user IDs (`client_user_ids`, list): Your own IDs for people, as a list or separated by commas.

**Outputs**

- `bulk_job_id` (text): The bulk job doing it; read it with 'Get bulk job'
- `member_count` (number): How many people were sent
- `message` (text): Attentive's confirmation
- `segment_external_id` (text): The segment

**Example output**

```json
{
  "bulk_job_id": "job_01HXAMPLE",
  "member_count": 2,
  "message": "Bulk job submitted",
  "segment_external_id": "vip-customers"
}
```

### Archive segment

Archive a segment so it no longer shows in lists. Attentive can restore it.

**Inputs**

- Segment (`segment_external_id`, text, required): The segment. Pick one, or give its external ID from an earlier step.

**Outputs**

- `archived` (true/false): True once archived
- `segment_external_id` (text): The segment archived

**Example output**

```json
{
  "archived": true,
  "segment_external_id": "vip-customers"
}
```

### Create or update person

Create a person in Attentive, or update the one with the same identifiers: name, birthday, address, locale and custom attributes. It can also subscribe them through a sign-up unit; only do that for people who agreed to hear from you.

**Inputs**

- Email (`email`, text): The person's email address.
- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Your user ID (`client_user_id`, text): Your own ID for the person, such as their customer number.
- Shopify customer ID (`shopify_id`, text): The person's Shopify customer ID, if you use Shopify.
- Klaviyo ID (`klaviyo_id`, text): The person's Klaviyo profile ID, if you use Klaviyo.
- Custom identifiers (`custom_identifiers`, object): Other IDs you keep for the person, by name, such as {"loyalty_id": "123"}.
- First name (`first_name`, text): The person's first name.
- Last name (`last_name`, text): The person's last name.
- Date of birth (`date_of_birth`, date): The person's date of birth.
- Organization (`organization`, text): The company or organization they belong to.
- Title (`title`, text): Their title, such as Mr, Ms or Dr.
- Website (`website`, text): Their website address.
- Address line 1 (`address1`, text): Street and number.
- Address line 2 (`address2`, text): Apartment or suite.
- City (`city`, text): Their city.
- State (`state`, text): Their state or province.
- ZIP or postal code (`zip_code`, text): Their ZIP or postal code.
- Country (`country`, text): Their country as a two-letter code, such as US.
- Locale (`locale`, text): The person's language and country. One of: `en-US` (English, United States), `es-US` (Spanish, United States), `en-CA` (English, Canada), `fr-CA` (French, Canada), `en-GB` (English, United Kingdom), `en-AU` (English, Australia).
- Custom attributes (`custom_attributes`, object): Your own attributes, such as {"Favorite color": "Blue"}. Values must be text, numbers or true/false. Attentive keeps at most 100 custom attributes.
- Sign-up unit ID (`sign_up_source_id`, text): The ID of an API sign-up unit, from the ID column of the Sign-up Units tab in Attentive. It sets which legal messages the person is sent.
- Subscribe to (`subscribe_channels`, list): Subscribe the person to texts, emails or both through the sign-up unit. Leave empty to only update their details. One or more of: `TEXT` (Text (SMS)), `EMAIL`.
- Skip the Reply Y text (`single_opt_in`, true/false): Subscribe without asking the person to reply Y first. Attentive strongly advises keeping the confirmation for legal reasons; talk to your Attentive manager before turning this on.

**Outputs**

- `accepted` (true/false): True once Attentive accepted the update
- `identifiers` (object): The identifiers the person was found or created by
- `message` (text): Attentive's own message

**Example output**

```json
{
  "accepted": true,
  "identifiers": {
    "email": "jo@example.com"
  },
  "message": "Request accepted"
}
```

### Create segment

Create an empty segment to add people to.

**Inputs**

- Name (`name`, text, required): The segment's name, up to 240 characters.
- Description (`description`, text): What the segment is for, 2 to 500 characters.
- External ID (`segment_external_id`, text): Your own ID for the segment. Leave empty for Attentive to make one.

**Outputs**

- `segment` (object): The new segment

**Example output**

```json
{
  "segment": {
    "created": "2026-11-01T09:00:00Z",
    "description": "Customers who spent over $500",
    "externalId": "vip-customers",
    "name": "VIP customers",
    "updated": "2026-11-02T09:00:00Z"
  }
}
```

### Get account

Get the Attentive company and custom app the connection uses.

**Inputs**: None.

**Outputs**

- `application_name` (text): The custom app's name
- `attentive_domain_name` (text): The company's Attentive domain
- `company_id` (text): The company's ID
- `company_name` (text): The company's name in Attentive
- `contact_email` (text): The custom app's contact email

**Example output**

```json
{
  "application_name": "Lodol",
  "attentive_domain_name": "hudsonivy.attn.tv",
  "company_id": "MDc6Q29tcGFueTI",
  "company_name": "Hudson & Ivy",
  "contact_email": "ops@example.com"
}
```

### Get bulk job

Check a bulk job, such as adding people to a segment: in progress, needs review, completed or cancelled, with a link to its results once done. Jobs are kept for two weeks.

**Inputs**

- Bulk job ID (`bulk_job_id`, text, required): The 'bulk_job_id' an earlier step returned.

**Outputs**

- `bulk_job_id` (text): The job's ID
- `results_url` (text): Where to download its results, once done
- `status` (text): IN_PROGRESS, NEEDS_REVIEW, COMPLETED or CANCELLED
- `total_records` (number): How many records it holds

**Example output**

```json
{
  "bulk_job_id": "job_01HXAMPLE",
  "results_url": "https://example.com/results.jsonl",
  "status": "COMPLETED",
  "total_records": 2
}
```

### Get custom attributes

Get every custom attribute Attentive holds for a person, found by phone or email (one, not both).

**Inputs**

- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Email (`email`, text): The person's email address.

**Outputs**

- `attributes` (list): Their attributes
- `count` (number): How many
- `values` (object): The same, as name and value pairs

**Example output**

```json
{
  "attributes": [
    {
      "name": "Favorite color",
      "value": "Blue"
    }
  ],
  "count": 1,
  "values": {
    "Favorite color": "Blue"
  }
}
```

### Get subscriptions

Check which texts and emails a person is subscribed to, and whether each can be sent to them now. Use it before messaging someone.

**Inputs**

- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Email (`email`, text): The person's email address.

**Outputs**

- `count` (number): How many
- `eligible_count` (number): How many can be sent to now
- `subscriptions` (list): Their subscriptions

**Example output**

```json
{
  "count": 1,
  "eligible_count": 1,
  "subscriptions": [
    {
      "channel": "TEXT",
      "is_eligible": true,
      "type": "MARKETING"
    }
  ]
}
```

### Link identifiers

Link your own user ID or custom identifiers to a person Attentive already knows by phone, email or another ID. Give at least two identifiers, one of them yours.

**Inputs**

- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Email (`email`, text): The person's email address.
- Shopify customer ID (`shopify_id`, text): The person's Shopify customer ID, if you use Shopify.
- Klaviyo ID (`klaviyo_id`, text): The person's Klaviyo profile ID, if you use Klaviyo.
- Your user ID (`client_user_id`, text): Your own ID for the person, such as their customer number.
- Custom identifiers (`custom_identifiers`, object): Other IDs you keep for the person, by name, such as {"loyalty_id": "123"}. Use IDs only, not details such as a first name.

**Outputs**

- `identifiers` (object): The identifiers sent
- `sent` (true/false): True once Attentive accepted them

**Example output**

```json
{
  "identifiers": {
    "clientUserId": "cust-123",
    "email": "jo@example.com"
  },
  "sent": true
}
```

### List catalog uploads

List recent catalog uploads, newest first, with their status, product counts and any mistakes Attentive found.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `uploads` (list): The uploads

**Example output**

```json
{
  "count": 1,
  "uploads": [
    {
      "errors": [
        {
          "errorMessage": "variants[0].prices is required",
          "errorType": "MISSING_FIELD",
          "lineNum": 3
        }
      ],
      "expires": "2026-11-19T10:00:00Z",
      "lastUpdated": "2026-11-18T10:00:00Z",
      "productsProcessed": 11,
      "productsReceived": 12,
      "status": "validated",
      "uploadId": "upl_01HXAMPLE",
      "validateOnly": true
    }
  ]
}
```

### List segments

List segments, optionally by name or recent change. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Name contains (`name`, text): Only segments whose name contains this.
- External ID (`segment_external_id`, text): Only the segment with this external ID.
- Changed since (`updated_since`, date and time): Only segments changed at or after this time.
- Page size (`limit`, number): How many to return, 1 to 1,000. Attentive's default is 20. From 1 to 1000.
- Next page (`cursor`, text): The 'next_cursor' from an earlier page.

**Outputs**

- `count` (number): How many on this page
- `has_more` (true/false): Whether there are more
- `next_cursor` (text): Give it as Next page for more; empty at the end
- `segments` (list): The segments

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "segments": [
    {
      "created": "2026-11-01T09:00:00Z",
      "description": "Customers who spent over $500",
      "externalId": "vip-customers",
      "name": "VIP customers",
      "updated": "2026-11-02T09:00:00Z"
    }
  ]
}
```

### Record add to cart

Tell Attentive a person added a product to their cart, for cart abandonment Journeys and segments.

**Inputs**

- Product ID (`product_id`, text, required): Your ID for the product, as in your product feed (the Shopify product ID if you use Shopify).
- Variant ID (`product_variant_id`, text, required): Your ID for the product's variant, such as Medium Blue.
- Price (`price`, number, required): The product's price, such as 19.99. At least 0.
- Currency (`currency`, text): Three-letter currency code, such as USD.
- Product name (`product_name`, text): The product's name, as it may appear in a message.
- Product page (`product_url`, text): The address of the product's page.
- Product image (`product_image`, text): The address of the product's image, at most 500 KB. It is used in picture messages.
- Quantity (`quantity`, number): How many. At least 1.
- More products (`more_items`, list): Other products in the same cart or order, each like {"productId": "T-SHIRT", "productVariantId": "T-SHIRT-M", "price": 19.99, "quantity": 1}.
- When it happened (`occurred_at`, date and time): When the person did it. Leave empty for now. Attentive starts no Journey for something more than 12 hours old.
- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Email (`email`, text): The person's email address.
- Your user ID (`client_user_id`, text): Your own ID for the person, such as their customer number.
- Custom identifiers (`custom_identifiers`, object): Other IDs you keep for the person, by name, such as {"loyalty_id": "123"}. Use IDs only, not details such as a first name.

**Outputs**

- `item_count` (number): How many products
- `items` (list): The products sent
- `occurred_at` (text): When it happened, empty for now
- `sent` (true/false): True once Attentive accepted the event

**Example output**

```json
{
  "item_count": 1,
  "items": [
    {
      "name": "Blue T-shirt",
      "price": [
        {
          "currency": "USD",
          "value": 19.99
        }
      ],
      "productId": "T-SHIRT",
      "productImage": "https://example.com/images/t-shirt.png",
      "productUrl": "https://example.com/products/t-shirt",
      "productVariantId": "T-SHIRT-M-BLUE",
      "quantity": 1
    }
  ],
  "occurred_at": "2026-11-18T10:00:00Z",
  "sent": true
}
```

### Record product view

Tell Attentive a person looked at a product, for browse abandonment Journeys and segments.

**Inputs**

- Product ID (`product_id`, text, required): Your ID for the product, as in your product feed (the Shopify product ID if you use Shopify).
- Variant ID (`product_variant_id`, text, required): Your ID for the product's variant, such as Medium Blue.
- Price (`price`, number, required): The product's price, such as 19.99. At least 0.
- Currency (`currency`, text): Three-letter currency code, such as USD.
- Product name (`product_name`, text): The product's name, as it may appear in a message.
- Product page (`product_url`, text): The address of the product's page.
- Product image (`product_image`, text): The address of the product's image, at most 500 KB. It is used in picture messages.
- Quantity (`quantity`, number): How many. At least 1.
- More products (`more_items`, list): Other products in the same cart or order, each like {"productId": "T-SHIRT", "productVariantId": "T-SHIRT-M", "price": 19.99, "quantity": 1}.
- When it happened (`occurred_at`, date and time): When the person did it. Leave empty for now. Attentive starts no Journey for something more than 12 hours old.
- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Email (`email`, text): The person's email address.
- Your user ID (`client_user_id`, text): Your own ID for the person, such as their customer number.
- Custom identifiers (`custom_identifiers`, object): Other IDs you keep for the person, by name, such as {"loyalty_id": "123"}. Use IDs only, not details such as a first name.

**Outputs**

- `item_count` (number): How many products
- `items` (list): The products sent
- `occurred_at` (text): When it happened, empty for now
- `sent` (true/false): True once Attentive accepted the event

**Example output**

```json
{
  "item_count": 1,
  "items": [
    {
      "name": "Blue T-shirt",
      "price": [
        {
          "currency": "USD",
          "value": 19.99
        }
      ],
      "productId": "T-SHIRT",
      "productImage": "https://example.com/images/t-shirt.png",
      "productUrl": "https://example.com/products/t-shirt",
      "productVariantId": "T-SHIRT-M-BLUE",
      "quantity": 1
    }
  ],
  "occurred_at": "2026-11-18T10:00:00Z",
  "sent": true
}
```

### Record purchase

Tell Attentive a person bought one or more products, for post-purchase Journeys, segments and revenue reporting.

**Inputs**

- Product ID (`product_id`, text, required): Your ID for the product, as in your product feed (the Shopify product ID if you use Shopify).
- Variant ID (`product_variant_id`, text, required): Your ID for the product's variant, such as Medium Blue.
- Price (`price`, number, required): The product's price, such as 19.99. At least 0.
- Currency (`currency`, text): Three-letter currency code, such as USD.
- Product name (`product_name`, text): The product's name, as it may appear in a message.
- Product page (`product_url`, text): The address of the product's page.
- Product image (`product_image`, text): The address of the product's image, at most 500 KB. It is used in picture messages.
- Quantity (`quantity`, number): How many. At least 1.
- More products (`more_items`, list): Other products in the same cart or order, each like {"productId": "T-SHIRT", "productVariantId": "T-SHIRT-M", "price": 19.99, "quantity": 1}.
- Order ID (`order_id`, text): Your order number.
- Sold through (`sales_channel`, text): Where the order was placed. One of: `WEB` (Website), `IOS_APP` (iOS app), `ANDROID_APP` (Android app), `IN_STORE` (In store), `PHONE`, `OTHER`.
- When it happened (`occurred_at`, date and time): When the person did it. Leave empty for now. Attentive starts no Journey for something more than 12 hours old.
- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Email (`email`, text): The person's email address.
- Your user ID (`client_user_id`, text): Your own ID for the person, such as their customer number.
- Custom identifiers (`custom_identifiers`, object): Other IDs you keep for the person, by name, such as {"loyalty_id": "123"}. Use IDs only, not details such as a first name.

**Outputs**

- `item_count` (number): How many products
- `items` (list): The products sent
- `occurred_at` (text): When it happened, empty for now
- `order_id` (text): The order number, if given
- `sent` (true/false): True once Attentive accepted the purchase

**Example output**

```json
{
  "item_count": 1,
  "items": [
    {
      "name": "Blue T-shirt",
      "price": [
        {
          "currency": "USD",
          "value": 19.99
        }
      ],
      "productId": "T-SHIRT",
      "productImage": "https://example.com/images/t-shirt.png",
      "productUrl": "https://example.com/products/t-shirt",
      "productVariantId": "T-SHIRT-M-BLUE",
      "quantity": 1
    }
  ],
  "occurred_at": "2026-11-18T10:00:00Z",
  "order_id": "1001",
  "sent": true
}
```

### Remove people from segment

Remove up to 10,000 people from a segment by email, phone or your user ID. Attentive does it in the background; 'Get bulk job' shows when it is done.

**Inputs**

- Segment (`segment_external_id`, text, required): The segment. Pick one, or give its external ID from an earlier step.
- Emails (`emails`, list): Email addresses, as a list or separated by commas.
- Phone numbers (`phones`, list): Phone numbers in international format, such as +15555555555, as a list or separated by commas.
- Your user IDs (`client_user_ids`, list): Your own IDs for people, as a list or separated by commas.

**Outputs**

- `bulk_job_id` (text): The bulk job doing it; read it with 'Get bulk job'
- `member_count` (number): How many people were sent
- `message` (text): Attentive's confirmation
- `segment_external_id` (text): The segment

**Example output**

```json
{
  "bulk_job_id": "job_01HXAMPLE",
  "member_count": 2,
  "message": "Bulk job submitted",
  "segment_external_id": "vip-customers"
}
```

### Request data deletion

Ask Attentive to delete a person and their data, such as for a privacy request. They are deleted within 30 days and it can't be undone.

**Inputs**

- Email (`email`, text): The person's email address.
- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Your user ID (`client_user_id`, text): Your own ID for the person, such as their customer number.
- Note (`note`, text): A note kept with the request for your records.

**Outputs**

- `processed` (true/false): Whether Attentive has finished it
- `request_id` (text): The deletion request's ID
- `requested_at` (text): When it was made
- `subject_email` (text): The email it is for
- `subject_phone` (text): The phone number it is for
- `type` (text): The kind of request

**Example output**

```json
{
  "processed": false,
  "request_id": "dr_01HXAMPLE",
  "requested_at": "2026-11-18T10:00:00Z",
  "subject_email": "jo@example.com",
  "subject_phone": "",
  "type": "DELETE"
}
```

### Send custom event

Record something a person did, such as Order shipped, with its details. It can start a Journey in Attentive, which messages the person only if they are subscribed.

**Inputs**

- Event name (`event_type`, text, required): The event's name, such as Order shipped. Capitals count, and it can't contain quotes, brackets, braces, commas, backslashes or vertical bars.
- Details (`properties`, object): Details to use in messages, such as {"trackingUrl": "https://example.com/t/1"}.
- Event ID (`external_event_id`, text): A unique ID for this event. Leave empty for a random one.
- When it happened (`occurred_at`, date and time): When the person did it. Leave empty for now. Attentive starts no Journey for something more than 12 hours old.
- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Email (`email`, text): The person's email address.
- Your user ID (`client_user_id`, text): Your own ID for the person, such as their customer number.
- Custom identifiers (`custom_identifiers`, object): Other IDs you keep for the person, by name, such as {"loyalty_id": "123"}. Use IDs only, not details such as a first name.

**Outputs**

- `event_type` (text): The event's name
- `external_event_id` (text): The event's ID
- `occurred_at` (text): When it happened, empty for now
- `sent` (true/false): True once Attentive accepted the event

**Example output**

```json
{
  "event_type": "Order shipped",
  "external_event_id": "4f8c2a6e-2b3d-4c55-9a1e-0b5b6f4e2a11",
  "occurred_at": "2026-11-18T10:00:00Z",
  "sent": true
}
```

### Set custom attributes

Set your own attributes on a person, such as Favorite color. A new name makes a new attribute; for one made in Attentive with set choices, the value must be one of them.

**Inputs**

- Attributes (`properties`, object, required): Attribute names and values, such as {"Favorite color": "Blue"}. Values must be text, numbers or true/false.
- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Email (`email`, text): The person's email address.
- Your user ID (`client_user_id`, text): Your own ID for the person, such as their customer number.
- Custom identifiers (`custom_identifiers`, object): Other IDs you keep for the person, by name, such as {"loyalty_id": "123"}. Use IDs only, not details such as a first name.

**Outputs**

- `properties` (object): The attributes sent
- `sent` (true/false): True once Attentive accepted them
- `user` (object): Who they were set on

**Example output**

```json
{
  "properties": {
    "Favorite color": "Blue"
  },
  "sent": true,
  "user": {
    "email": "jo@example.com",
    "externalIdentifiers": {
      "clientUserId": "cust-123",
      "customIdentifiers": [
        {
          "name": "loyalty_id",
          "value": "L-42"
        }
      ]
    },
    "phone": "+15555555555"
  }
}
```

### Subscribe person

Opt a person in to your texts or emails. Only subscribe people who agreed to hear from you: Attentive records their consent through the sign-up unit and sends them its confirmation and legal messages (a Reply Y text for texts). Someone already subscribed to texts is sent a text saying so.

**Inputs**

- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Email (`email`, text): The person's email address.
- Sign-up unit ID (`sign_up_source_id`, text): The ID of an API sign-up unit, from the ID column of the Sign-up Units tab in Attentive. It sets which legal messages the person is sent.
- Locale (`locale`, text): The person's language and country. One of: `en-US` (English, United States), `es-US` (Spanish, United States), `en-CA` (English, Canada), `fr-CA` (French, Canada), `en-GB` (English, United Kingdom), `en-AU` (English, Australia).
- Subscription type (`subscription_type`, text): Marketing or transactional. With a locale, used instead of a sign-up unit ID when one API sign-up unit matches both. One of: `MARKETING`, `TRANSACTIONAL`.
- Skip the Reply Y text (`single_opt_in`, true/false): Subscribe without asking the person to reply Y first. Attentive strongly advises keeping the confirmation for legal reasons; talk to your Attentive manager before turning this on.
- Your user ID (`client_user_id`, text): Your own ID for the person, such as their customer number.
- Shopify customer ID (`shopify_id`, text): The person's Shopify customer ID, if you use Shopify.
- Klaviyo ID (`klaviyo_id`, text): The person's Klaviyo profile ID, if you use Klaviyo.
- Custom identifiers (`custom_identifiers`, object): Other IDs you keep for the person, by name, such as {"loyalty_id": "123"}. Use IDs only, not details such as a first name.

**Outputs**

- `count` (number): How many
- `subscriptions` (list): Each subscription, new or one they already had
- `user` (object): The person

**Example output**

```json
{
  "count": 1,
  "subscriptions": [
    {
      "subscription": {
        "channel": "TEXT",
        "type": "MARKETING"
      },
      "subscriptionCreationStatus": "NEWLY_CREATED"
    }
  ],
  "user": {
    "email": "jo@example.com",
    "phone": "+15555555555"
  }
}
```

### Unsubscribe person

Opt a person out of their texts, emails or both. A phone number finds only text subscriptions and an email only email ones. Choosing nothing unsubscribes them from everything. Attentive texts a confirmation unless told not to.

**Inputs**

- Phone (`phone`, text): The person's mobile number in international format with the country code, such as +15555555555.
- Email (`email`, text): The person's email address.
- Channels (`channels`, list): Unsubscribe from texts, emails or both. Empty means both. One or more of: `TEXT` (Text (SMS)), `EMAIL`.
- Subscription types (`subscription_types`, list): Which kinds to leave. Empty means every kind. One or more of: `MARKETING`, `TRANSACTIONAL`, `CHECKOUT_ABANDONED` (Checkout abandoned), `CONTACT`.
- Confirmation language (`notification_language`, text): The language of the confirmation text. One of: `en-US` (English (US)), `fr-CA` (French (Canada)).
- Don't send a confirmation (`skip_confirmation`, true/false): Unsubscribe without sending the confirmation message.

**Outputs**

- `count` (number): How many
- `subscriptions` (list): Each subscription and whether it was already left
- `user` (object): The person

**Example output**

```json
{
  "count": 1,
  "subscriptions": [
    {
      "subscription": {
        "channel": "TEXT",
        "type": "MARKETING"
      },
      "subscriptionUnsubscribeStatus": "NEWLY_UNSUBSCRIBED"
    }
  ],
  "user": {
    "email": "jo@example.com",
    "phone": "+15555555555"
  }
}
```

### Update segment

Rename a segment or change its description. Only the fields given change.

**Inputs**

- Segment (`segment_external_id`, text, required): The segment. Pick one, or give its external ID from an earlier step.
- New name (`name`, text): A new name. Leave empty to keep it.
- New description (`description`, text): A new description, 2 to 500 characters. Leave empty to keep it.

**Outputs**

- `segment` (object): The segment, changed

**Example output**

```json
{
  "segment": {
    "created": "2026-11-01T09:00:00Z",
    "description": "Customers who spent over $500",
    "externalId": "vip-customers",
    "name": "Top customers",
    "updated": "2026-11-02T09:00:00Z"
  }
}
```

### Upload product catalog

Send products to Attentive's catalog for back in stock, low inventory and price drop Journeys, or only check them. Attentive checks and saves them in the background; 'List catalog uploads' shows how it went.

**Inputs**

- Products (`products`, list, required): The products in Attentive's catalog format: each needs id, name, link, lastUpdated and variants (each with id, name, link, prices, availableForPurchase and lastUpdated).
- Only check the products (`validate_only`, true/false): Check the products for mistakes without saving them.

**Outputs**

- `products_sent` (number): How many products were sent
- `upload` (object): The upload, as it started
- `upload_id` (text): The upload's ID
- `validate_only` (true/false): Whether they were only checked

**Example output**

```json
{
  "products_sent": 12,
  "upload": {
    "errors": [],
    "expires": "2026-11-19T10:00:00Z",
    "lastUpdated": "2026-11-18T10:00:00Z",
    "productsProcessed": 0,
    "productsReceived": 0,
    "status": "initialized",
    "uploadId": "upl_01HXAMPLE",
    "validateOnly": true
  },
  "upload_id": "upl_01HXAMPLE",
  "validate_only": true
}
```
