Attentive
App · 22 actions
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.
Actions
| Action | What it does |
|---|---|
| Add people to segment | Add up to 10,000 people to a segment by email, phone or your user ID. |
| Archive segment | Archive a segment so it no longer shows in lists. |
| Create or update person | Create a person in Attentive, or update the one with the same identifiers: name, birthday, address, locale and custom attributes. |
| Create segment | Create an empty segment to add people to. |
| Get account | Get the Attentive company and custom app the connection uses. |
| 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. |
| Get custom attributes | Get every custom attribute Attentive holds for a person, found by phone or email (one, not both). |
| Get subscriptions | Check which texts and emails a person is subscribed to, and whether each can be sent to them now. |
| Link identifiers | Link your own user ID or custom identifiers to a person Attentive already knows by phone, email or another ID. |
| List catalog uploads | List recent catalog uploads, newest first, with their status, product counts and any mistakes Attentive found. |
| List segments | List segments, optionally by name or recent change. |
| Record add to cart | Tell Attentive a person added a product to their cart, for cart abandonment Journeys and segments. |
| Record product view | Tell Attentive a person looked at a product, for browse abandonment Journeys and segments. |
| Record purchase | Tell Attentive a person bought one or more products, for post-purchase Journeys, segments and revenue reporting. |
| Remove people from segment | Remove up to 10,000 people from a segment by email, phone or your user ID. |
| Request data deletion | Ask Attentive to delete a person and their data, such as for a privacy request. |
| Send custom event | Record something a person did, such as Order shipped, with its details. |
| Set custom attributes | Set your own attributes on a person, such as Favorite color. |
| Subscribe person | Opt a person in to your texts or emails. |
| Unsubscribe person | Opt a person out of their texts, emails or both. |
| Update segment | Rename a segment or change its description. |
| Upload product catalog | Send products to Attentive's catalog for back in stock, low inventory and price drop Journeys, or only check them. |
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_idtextRequired - The segment. Pick one, or give its external ID from an earlier step.
- Emails
emailslist - Email addresses, as a list or separated by commas.
- Phone numbers
phoneslist - Phone numbers in international format, such as +15555555555, as a list or separated by commas.
- Your user IDs
client_user_idslist - Your own IDs for people, as a list or separated by commas.
Outputs
bulk_job_idtext- The bulk job doing it; read it with 'Get bulk job'
member_countnumber- How many people were sent
messagetext- Attentive's confirmation
segment_external_idtext- The segment
Example output
{
"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_idtextRequired - The segment. Pick one, or give its external ID from an earlier step.
Outputs
archivedtrue/false- True once archived
segment_external_idtext- The segment archived
Example output
{
"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
emailtext - The person's email address.
- Phone
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Your user ID
client_user_idtext - Your own ID for the person, such as their customer number.
- Shopify customer ID
shopify_idtext - The person's Shopify customer ID, if you use Shopify.
- Klaviyo ID
klaviyo_idtext - The person's Klaviyo profile ID, if you use Klaviyo.
- Custom identifiers
custom_identifiersobject - Other IDs you keep for the person, by name, such as {"loyalty_id": "123"}.
- First name
first_nametext - The person's first name.
- Last name
last_nametext - The person's last name.
- Date of birth
date_of_birthdate - The person's date of birth.
- Organization
organizationtext - The company or organization they belong to.
- Title
titletext - Their title, such as Mr, Ms or Dr.
- Website
websitetext - Their website address.
- Address line 1
address1text - Street and number.
- Address line 2
address2text - Apartment or suite.
- City
citytext - Their city.
- State
statetext - Their state or province.
- ZIP or postal code
zip_codetext - Their ZIP or postal code.
- Country
countrytext - Their country as a two-letter code, such as US.
- Locale
localetext - 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_attributesobject - 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_idtext - 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_channelslist - 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_intrue/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
acceptedtrue/false- True once Attentive accepted the update
identifiersobject- The identifiers the person was found or created by
messagetext- Attentive's own message
Example output
{
"accepted": true,
"identifiers": {
"email": "jo@example.com"
},
"message": "Request accepted"
}Create segment
Create an empty segment to add people to.
Inputs
- Name
nametextRequired - The segment's name, up to 240 characters.
- Description
descriptiontext - What the segment is for, 2 to 500 characters.
- External ID
segment_external_idtext - Your own ID for the segment. Leave empty for Attentive to make one.
Outputs
segmentobject- The new segment
Example output
{
"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_nametext- The custom app's name
attentive_domain_nametext- The company's Attentive domain
company_idtext- The company's ID
company_nametext- The company's name in Attentive
contact_emailtext- The custom app's contact email
Example output
{
"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_idtextRequired - The 'bulk_job_id' an earlier step returned.
Outputs
bulk_job_idtext- The job's ID
results_urltext- Where to download its results, once done
statustext- IN_PROGRESS, NEEDS_REVIEW, COMPLETED or CANCELLED
total_recordsnumber- How many records it holds
Example output
{
"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
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Email
emailtext - The person's email address.
Outputs
attributeslist- Their attributes
countnumber- How many
valuesobject- The same, as name and value pairs
Example output
{
"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
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Email
emailtext - The person's email address.
Outputs
countnumber- How many
eligible_countnumber- How many can be sent to now
subscriptionslist- Their subscriptions
Example output
{
"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
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Email
emailtext - The person's email address.
- Shopify customer ID
shopify_idtext - The person's Shopify customer ID, if you use Shopify.
- Klaviyo ID
klaviyo_idtext - The person's Klaviyo profile ID, if you use Klaviyo.
- Your user ID
client_user_idtext - Your own ID for the person, such as their customer number.
- Custom identifiers
custom_identifiersobject - 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
identifiersobject- The identifiers sent
senttrue/false- True once Attentive accepted them
Example output
{
"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
countnumber- How many
uploadslist- The uploads
Example output
{
"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
nametext - Only segments whose name contains this.
- External ID
segment_external_idtext - Only the segment with this external ID.
- Changed since
updated_sincedate and time - Only segments changed at or after this time.
- Page size
limitnumber - How many to return, 1 to 1,000. Attentive's default is 20.From 1 to 1000.
- Next page
cursortext - The 'next_cursor' from an earlier page.
Outputs
countnumber- How many on this page
has_moretrue/false- Whether there are more
next_cursortext- Give it as Next page for more; empty at the end
segmentslist- The segments
Example output
{
"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_idtextRequired - Your ID for the product, as in your product feed (the Shopify product ID if you use Shopify).
- Variant ID
product_variant_idtextRequired - Your ID for the product's variant, such as Medium Blue.
- Price
pricenumberRequired - The product's price, such as 19.99.At least 0.
- Currency
currencytext - Three-letter currency code, such as USD.
- Product name
product_nametext - The product's name, as it may appear in a message.
- Product page
product_urltext - The address of the product's page.
- Product image
product_imagetext - The address of the product's image, at most 500 KB. It is used in picture messages.
- Quantity
quantitynumber - How many.At least 1.
- More products
more_itemslist - 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_atdate and time - When the person did it. Leave empty for now. Attentive starts no Journey for something more than 12 hours old.
- Phone
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Email
emailtext - The person's email address.
- Your user ID
client_user_idtext - Your own ID for the person, such as their customer number.
- Custom identifiers
custom_identifiersobject - 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_countnumber- How many products
itemslist- The products sent
occurred_attext- When it happened, empty for now
senttrue/false- True once Attentive accepted the event
Example output
{
"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_idtextRequired - Your ID for the product, as in your product feed (the Shopify product ID if you use Shopify).
- Variant ID
product_variant_idtextRequired - Your ID for the product's variant, such as Medium Blue.
- Price
pricenumberRequired - The product's price, such as 19.99.At least 0.
- Currency
currencytext - Three-letter currency code, such as USD.
- Product name
product_nametext - The product's name, as it may appear in a message.
- Product page
product_urltext - The address of the product's page.
- Product image
product_imagetext - The address of the product's image, at most 500 KB. It is used in picture messages.
- Quantity
quantitynumber - How many.At least 1.
- More products
more_itemslist - 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_atdate and time - When the person did it. Leave empty for now. Attentive starts no Journey for something more than 12 hours old.
- Phone
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Email
emailtext - The person's email address.
- Your user ID
client_user_idtext - Your own ID for the person, such as their customer number.
- Custom identifiers
custom_identifiersobject - 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_countnumber- How many products
itemslist- The products sent
occurred_attext- When it happened, empty for now
senttrue/false- True once Attentive accepted the event
Example output
{
"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_idtextRequired - Your ID for the product, as in your product feed (the Shopify product ID if you use Shopify).
- Variant ID
product_variant_idtextRequired - Your ID for the product's variant, such as Medium Blue.
- Price
pricenumberRequired - The product's price, such as 19.99.At least 0.
- Currency
currencytext - Three-letter currency code, such as USD.
- Product name
product_nametext - The product's name, as it may appear in a message.
- Product page
product_urltext - The address of the product's page.
- Product image
product_imagetext - The address of the product's image, at most 500 KB. It is used in picture messages.
- Quantity
quantitynumber - How many.At least 1.
- More products
more_itemslist - 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_idtext - Your order number.
- Sold through
sales_channeltext - 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_atdate and time - When the person did it. Leave empty for now. Attentive starts no Journey for something more than 12 hours old.
- Phone
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Email
emailtext - The person's email address.
- Your user ID
client_user_idtext - Your own ID for the person, such as their customer number.
- Custom identifiers
custom_identifiersobject - 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_countnumber- How many products
itemslist- The products sent
occurred_attext- When it happened, empty for now
order_idtext- The order number, if given
senttrue/false- True once Attentive accepted the purchase
Example output
{
"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_idtextRequired - The segment. Pick one, or give its external ID from an earlier step.
- Emails
emailslist - Email addresses, as a list or separated by commas.
- Phone numbers
phoneslist - Phone numbers in international format, such as +15555555555, as a list or separated by commas.
- Your user IDs
client_user_idslist - Your own IDs for people, as a list or separated by commas.
Outputs
bulk_job_idtext- The bulk job doing it; read it with 'Get bulk job'
member_countnumber- How many people were sent
messagetext- Attentive's confirmation
segment_external_idtext- The segment
Example output
{
"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
emailtext - The person's email address.
- Phone
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Your user ID
client_user_idtext - Your own ID for the person, such as their customer number.
- Note
notetext - A note kept with the request for your records.
Outputs
processedtrue/false- Whether Attentive has finished it
request_idtext- The deletion request's ID
requested_attext- When it was made
subject_emailtext- The email it is for
subject_phonetext- The phone number it is for
typetext- The kind of request
Example output
{
"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_typetextRequired - The event's name, such as Order shipped. Capitals count, and it can't contain quotes, brackets, braces, commas, backslashes or vertical bars.
- Details
propertiesobject - Details to use in messages, such as {"trackingUrl": "https://example.com/t/1"}.
- Event ID
external_event_idtext - A unique ID for this event. Leave empty for a random one.
- When it happened
occurred_atdate and time - When the person did it. Leave empty for now. Attentive starts no Journey for something more than 12 hours old.
- Phone
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Email
emailtext - The person's email address.
- Your user ID
client_user_idtext - Your own ID for the person, such as their customer number.
- Custom identifiers
custom_identifiersobject - 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_typetext- The event's name
external_event_idtext- The event's ID
occurred_attext- When it happened, empty for now
senttrue/false- True once Attentive accepted the event
Example output
{
"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
propertiesobjectRequired - Attribute names and values, such as {"Favorite color": "Blue"}. Values must be text, numbers or true/false.
- Phone
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Email
emailtext - The person's email address.
- Your user ID
client_user_idtext - Your own ID for the person, such as their customer number.
- Custom identifiers
custom_identifiersobject - 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
propertiesobject- The attributes sent
senttrue/false- True once Attentive accepted them
userobject- Who they were set on
Example output
{
"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
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Email
emailtext - The person's email address.
- Sign-up unit ID
sign_up_source_idtext - 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
localetext - 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_typetext - 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_intrue/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_idtext - Your own ID for the person, such as their customer number.
- Shopify customer ID
shopify_idtext - The person's Shopify customer ID, if you use Shopify.
- Klaviyo ID
klaviyo_idtext - The person's Klaviyo profile ID, if you use Klaviyo.
- Custom identifiers
custom_identifiersobject - 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
countnumber- How many
subscriptionslist- Each subscription, new or one they already had
userobject- The person
Example output
{
"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
phonetext - The person's mobile number in international format with the country code, such as +15555555555.
- Email
emailtext - The person's email address.
- Channels
channelslist - Unsubscribe from texts, emails or both. Empty means both.One or more of:
TEXT(Text (SMS)),EMAIL. - Subscription types
subscription_typeslist - Which kinds to leave. Empty means every kind.One or more of:
MARKETING,TRANSACTIONAL,CHECKOUT_ABANDONED(Checkout abandoned),CONTACT. - Confirmation language
notification_languagetext - The language of the confirmation text.One of:
en-US(English (US)),fr-CA(French (Canada)). - Don't send a confirmation
skip_confirmationtrue/false - Unsubscribe without sending the confirmation message.
Outputs
countnumber- How many
subscriptionslist- Each subscription and whether it was already left
userobject- The person
Example output
{
"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_idtextRequired - The segment. Pick one, or give its external ID from an earlier step.
- New name
nametext - A new name. Leave empty to keep it.
- New description
descriptiontext - A new description, 2 to 500 characters. Leave empty to keep it.
Outputs
segmentobject- The segment, changed
Example output
{
"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
productslistRequired - 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_onlytrue/false - Check the products for mistakes without saving them.
Outputs
products_sentnumber- How many products were sent
uploadobject- The upload, as it started
upload_idtext- The upload's ID
validate_onlytrue/false- Whether they were only checked
Example output
{
"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
}