Skip to main content

Update Audience

PUT 
/audiences/:id

Update an existing audience list​

Updates the membership of an existing Audience by adding new customers or removing existing ones.
Use this endpoint to manage and maintain up-to-date customer's lists, ensuring your audience data stays accurate and organized.

Updates the membership of an existing Audience list:

  • Use the assignMembers array to add new customers (email addresses), with optional profile attributes such as name, tags, location, and purchase history.
  • Use the unAssignMembers array to remove customers by their email addresses.

This endpoint allows you to efficiently maintain and manage your Audience data, keeping customers lists accurate and up to date.

Workflows:

  • If a workflow is associated with the contact list, adding new members will automatically trigger that workflow for the newly added contacts.

Request​

Path Parameters

    id uuidrequired

    ID of the Audience to update

Body

required
    assignMembers object[]

    Customers to add in Audience

  • Array [
    • email stringrequired
    firstName string
    lastName string
    source string
    birthday string
    tags string[]
    currency string
    country string
    province string
    city string
    address1 string
    address2 string
    phone string
    postalCode string
    company string
    lastPurchaseOrder string
    lastPurchasePrice string
    latestOrderId string
  • ]
    • unAssignMembers string[]

    Email of the customers to be removed

Responses​

Successful operation

Loading...