Update a Custom Segment

Updates the name and/or description of a custom segment

Query Parameters

name
Type: string

Updated name of the custom segment
description
Type: string

Updated description of the custom segment
custom_segment_id
Type: string

Unique ID of the custom segment that will be updated. This ID is generated by Punchh when the custom segment is created.

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
application/json

patch/api2/dashboard/custom_segments

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

Show Schema

{
  "custom_segment_id": 15401,
  "name": "Updated Name - Dummy Custom Segment",
  "description": "Updated Description - Request to create dummy custom segment.",
  "created_at": "2018-01-10T10:33:14Z",
  "updated_at": "2018-01-10T10:37:21Z"
}

Create a Custom Segment

Delete a Custom Segment