post-api2-redeemable-distribution

Commit Redeemable Distribution

​

Triggers configuration and scheduling of a mass offer campaign on Punchh. This is used by an external platform to request Punchh to deliver offers to a target segment of guests using the Punchh mass offer campaign functionality. When using this endpoint to request scheduling of a mass offer campaign on Punchh, the mass offer campaign created will not have any marketing communication configured (email, push notification, SMS, etc.), and the mass offer campaign will only distribute a Punchh redeemable to the guests in the targeted segment.

For more information, see Headless Offers Management - Distribution

Headers
  • Content-Type
    Type: string
    required

    application/json

  • Accept
    Type: string
    required

    application/json

  • Authorization
    Type: string
    required

    Bearer token for admin authorization, who is making a call on behalf of the customer

Body
application/json
  • campaign_type
    Type: string
    required

    Campaign type. For example: mass gifting campaign, coupon campaign (currently only mass gifting campaign is supported)

  • category
    Type: string
    required

    Gift type. For example: gift_redeemable, gift_fixed_point (currently only gift_redeemable is supported)

  • external_campaign_id
    Type: string

    ID of third-party campaign

  • name
    Type: string
    required

    Campaign name

  • redeemable_uuid
    Type: string
    required

    Redeemable UUID

  • segment_id
    Type: integer
    required

    Segment ID of the group of users for mass gifting

  • start_time
    Type: string
    required

    Start time of the campaign

Responses
  • 200
    Type: object
    • campaign_id
      Type: integer

      ID of the campaign

    • external_source_id
      Type: string

      ID of third-party campaign

    • redeemable_id
      Type: integer

      ID of the redeemable

    • redeemable_image_url
      Type: string

      Image URL for the redeemable

    • redeemable_properties
      Type: string

      Specifies the redeemable attribute

    • start_time
      Type: stringFormat: date-time

      Start time of the campaign

    • time_zone
      Type: string

      Time zone of the campaign

  • 400
    Type: object
  • 404
    Type: object
  • 422
    Type: object
post/api2/dashboard/campaigns
{
  "redeemable_id": 20416,
  "redeemable_image_url": "IMAGE_URL_GOES_HERE",
  "redeemable_properties": "attribute",
  "campaign_id": 99511494,
  "external_source_id": "2",
  "start_time": "2021-09-14 06:44 PM",
  "timezone": "Etc/UTC"
}

Success