How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Punchh Custom Segments API

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

Punchh Custom Segments API is one of 46 APIs that Punchh publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 26 JSON Schema definitions.

Tagged areas include Custom Segments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a JSON-LD context, and 26 JSON Schemas.

This API exposes 10 operations across 5 paths. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://SERVER_NAME_GOES_HERE.punchh.com.

10 operations 5 paths 0 schemas 3 DELETE2 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{server_name}.punchh.com
Resource Areas
1

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 3 DELETE, 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Segments 10
GET
/api2/dashboard/custom_segments
List All Custom Segments
dashboard_list_all_custom_segments 3 params → 200401
POST
/api2/dashboard/custom_segments
Create a Custom Segment
dashboard_create_custom_segment 2 params body → 201401422
PATCH
/api2/dashboard/custom_segments
Update a Custom Segment
dashboard_update_custom_segment 5 params → 200401
DELETE
/api2/dashboard/custom_segments
Delete a Custom Segment
dashboard_delete_custom_segment 3 params → 202401404
GET
/api2/dashboard/custom_segments/members
Search If User Exists in a Custom Segment
dashboard_search_user_in_custom_segment 5 params → 200400401404
POST
/api2/dashboard/custom_segments/members
Add User to a Custom Segment
dashboard_add_user_to_custom_segment 2 params body → 201400401404
DELETE
/api2/dashboard/custom_segments/members
Remove User From a Custom Segment
dashboard_remove_user_from_custom_segment 5 params → 204
POST
/api2/dashboard/custom_segments/members/bulk_add
Bulk Add Users to a Custom Segment
post-api2-dashboard-custom_segments-members-bulk_add 2 params body → 200302
DELETE
/api2/dashboard/custom_segments/members/bulk_remove
Bulk Remove Users From a Custom Segment
delete-api2-dashboard-custom_segments-members-bulk_remove 2 params body → 200302
POST
/api2/dashboard/custom_segments/members/add_users
Bulk Add Users to a Custom List Segment
post-api2-dashboard-custom_segments-members-add_users 2 params body → 200422

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

punchh-custom-segments-api-openapi.yml Raw ↑

Other APIs Punchh publishes across the network.

Punchh POS API
Punchh Api2 API
Punchh Auth API
Punchh Badges API
Punchh Beacons API
Punchh Business Admin Users API
Punchh Business Migration Users API
Punchh Challenges API
Punchh Check In API
Punchh Check Ins API
Punchh Check User Balance API
Punchh Collectibles API
Where this information came from

This is an independent, third-party profile of Punchh Custom Segments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.