Punchh

Punchh Custom Segments API

The Custom Segments API from Punchh — 5 operation(s) for custom segments.

Documentation GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api2/dashboard/custom_segments List all custom segments · List All Custom Segments #

Ask an LLM

“What custom segments has my business created?”

“Can I see every custom guest list we've built?”

Tell an agent

List all of our custom segments.

Show the custom segments, including segment {ID}.

POST /api2/dashboard/custom_segments Create an empty custom segment · Create a Custom Segment #

Ask an LLM

“How do I create a new custom segment to hold a hand-picked list of guests?”

“Are users added at the time a custom segment is created?”

Tell an agent

Create a custom segment named {name}.

Make a new custom segment {name} described as {description}.

PATCH /api2/dashboard/custom_segments Rename or redescribe a custom segment · Update a Custom Segment #

Ask an LLM

“Can I change the name or description of an existing custom segment?”

“What fields of a custom segment can be edited?”

Tell an agent

Rename custom segment {custom_segment_id} to {name}.

Update the description of custom segment {custom_segment_id} to {description}.

DELETE /api2/dashboard/custom_segments Delete a custom segment · Delete a Custom Segment #

Ask an LLM

“How do I permanently remove a custom segment we no longer use?”

“Can a deleted custom segment be recovered?”

Tell an agent destructive · confirm first

Delete custom segment {custom_segment_id}.

Remove the custom segment {custom_segment_id} from the database.

GET /api2/dashboard/custom_segments/members Check whether a guest is in a custom segment · Search If User Exists in a Custom Segment #

Ask an LLM

“Is a particular guest already a member of this custom segment?”

“Can I check segment membership by email instead of user ID?”

Tell an agent

Check if {email} belongs to custom segment {custom_segment_id}.

Is user {user_id} in custom segment {custom_segment_id}? Look it up.

POST /api2/dashboard/custom_segments/members Add one guest to a custom segment · Add User to a Custom Segment #

Ask an LLM

“How do I add a single guest to a custom segment?”

“If I pass both an email and a user ID when adding a guest, which one wins?”

Tell an agent

Add {email} to custom segment {custom_segment_id}.

Put user {user_id} into custom segment {custom_segment_id}.

DELETE /api2/dashboard/custom_segments/members Remove one guest from a custom segment · Remove User From a Custom Segment #

Ask an LLM

“How do I take a single guest out of a custom segment?”

“Can I remove someone from a segment using just their email?”

Tell an agent destructive · confirm first

Remove {email} from custom segment {custom_segment_id}.

Take user {user_id} out of custom segment {custom_segment_id}.

POST /api2/dashboard/custom_segments/members/bulk_add Bulk add guests to a segment from a CSV · Bulk Add Users to a Custom Segment #

Ask an LLM

“Can I upload a CSV of user IDs and emails to fill a custom segment?”

“What columns does the bulk add CSV file need?”

Tell an agent

Upload CSV {bulk_guest_activity_file} to add users to custom segment {custom_segment_id} as job {name}.

Run a bulk CSV add named {name} into segment {custom_segment_id} from {bulk_guest_activity_file}.

DELETE /api2/dashboard/custom_segments/members/bulk_remove Bulk remove guests from a segment via CSV · Bulk Remove Users From a Custom Segment #

Ask an LLM

“How do I remove many guests from a custom segment at once with a file?”

“Does the bulk removal CSV use the same user_id and email columns?”

Tell an agent destructive · confirm first

Remove the users in CSV {bulk_guest_activity_file} from custom segment {custom_segment_id} as job {name}.

Bulk-remove guests from segment {custom_segment_id} using file {bulk_guest_activity_file}, job name {name}.

POST /api2/dashboard/custom_segments/members/add_users Bulk add guests to a list segment by ID or email · Bulk Add Users to a Custom List Segment #

Ask an LLM

“Can I add a list of emails and user IDs to a custom list segment without uploading a file?”

“Which identifiers come back as invalid when adding users in bulk, and can it run asynchronously?”

Tell an agent

Add these users {user_identifiers} to custom list segment {custom_segment_id}.

Asynchronously add {user_identifiers} to list segment {custom_segment_id} using method {bulk_method}.

Punchh Custom Segments API

Operations 10

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification