Make a call to this endpoint for any attribute-based data.

Make a call to this endpoint to get recent catalog uploads with their statuses to gain visibility into the ingestion workflow in order of creation. See the POST of this endpoint for details.

Use the Identity API to manage user identifiers. With this API, you can programmatically add a client user identifier or custom identifier(s) to a user. You should only use clientUserId and customIdentifiers to send Attentive your system-assigned unique identifiers (even when testing).

Make a call to this endpoint to unsubscribe a user from a subscription type or channel. If no subscriptions are present in the request, the user is unsubscribed from all subscriptions. If subscriptions are present in the request, the user is unsubscribed from the requested type or channel combination. By default, if a subscription exists, but the user is already unsubscribed, it records the attempt to unsubscribe the subscription again. For TEXT subscriptions, a message is sent to the person indicating that they are unsubscribed.

Make a call to this endpoint when a user generates an order or purchase.

Make a call to this endpoint to list all subscription types and channels a user is subscribed to. You can query for a subscriber using either their phone number or email. One of the query parameters is required in order to look up a subscriber. As an example, you can use this endpoint to check if a subscriber is eligible to receive SMS or email campaigns, and then send them a message based on that eligibility.

Triggers when a subscription is confirmed following a double opt-in.

Triggers when a user unsubscribes.

Triggers when a user upgrades their subscription to premium.

Adds a subscriber to a specific automation.

Creates a custom field in your beehiiv account.

Makes a custom API call to a specified endpoint with custom parameters.

Deletes a custom field from your beehiiv account.

Deletes a particular segment.

Updates custom fields and/or unsubscribes a subscriber.

Returns a list of all automations.

Return a list of members from a specific segment.

Returns a list of posts for a particular publication.

Return a list of segments from a publication.

Views the details of a single automation.

Views the details of a single custom field.

Retrieve the details of a single publication.

Shows the details of a single subscriber using their email address.

Make a call to this endpoint when a user adds a product to their shopping cart.

Make a call to this endpoint for any event-based data representing user actions.

Make a call to this endpoint to subscribe a user to subscriptions. Note that when a user is subscribed programmatically, it must include

Make a call to this endpoint when a user views a product.

Creates or updates a single user record, including associated attributes, subscriptions, and identifiers. If a user with the provided identifiers already exists, their information will be updated; otherwise, a new user will be created. There is a limit of 100 of custom attributes that can be created. If intending to update an existing attribute, the name of the key must match the name of the existing attribute. If an existing attribute does not exist, a new attribute will be created with the given key as the name. Attributes with enumerated values must have a value that matches an existing enum value; new enum values will not be created. Attempting to pass custom attributes as an array or a map such as ["New York City] or {"favorite city": "Boston"} will result in a 400 error.

Triggers when a new post is sent.

Triggers when a new subscription is created.

Triggers when a subscriber downgrades their subscription from premium to free.

Triggers when a new survey response is submitted.

Add subscriber tags to an existing subscriber.

Creates a subscriber in your beehiiv account.

Deletes a subscriber from your publication.

Deletes (a draft) or archives (a published) a post.

Updates a custom field for a publication.

Returns a list of all automation journeys for a specific automation. This will include the status of the journey, the start time, and the completion time.

Returns a list of custom fields.

Returns a list of publications with their publication IDs.

Retrieve details about the publication's referral program, including milestones and rewards.

Retrieve all subscriptions belonging to a specific publication.

Views the details of a single automation journey.

View the details of a single post.

Shows the details of a single segment.

Shows the details of a single subscriber.