Remove User From a Custom Segment

Removes a user from a custom segment. Either email or user_id should be provided in the request; user_id will be preferred if both are provided.

Query Parameters

custom_segment_id
Type: integerFormat: int64

Unique ID of the custom segment from which the user will be removed. This is assigned by Punchh.
email
Type: string

Email address of the user
user_id
Type: integerFormat: int64

Unique ID of the user. This is generated by Punchh.

Headers

Authorization
Type: string
required

Bearer token for admin authorization, who is making a call on behalf of the customer. Send the API key in the following format: "Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE".
Accept
Type: string
required

Advertises which content types the client is able to understand

Responses

application/json

delete/api2/dashboard/custom_segments/members

curl https://SERVER_NAME_GOES_HERE.punchh.com/api2/dashboard/custom_segments/members \
  --request DELETE \
  --header 'Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE' \
  --header 'Accept: application/json'

Show Schema

{}

You will receive a 204 blank response.

Add User to a Custom Segment

Bulk Add Users to a Custom Segment