API docs by Redocly

Favordrop API Documentation (1.0.0)

Download OpenAPI specification:Download

Create a Favordrop to send

Use this endpoint to create a Favordrop and send it.

header Parameters
Authorization
string

JWT authorization token.

organization-api-key
string

Organization API key. This is required if auth token is not provided.

Request Body schema: application/json
customer
string

The unique identifier of the customer. Either customer, or customer details (fname, lname, phone, email) are required.

fname
string

The first name of the customer. Required if customer is not provided

lname
string

The last name of the customer. Required if customer is not provided

phone
string

The phone number of the customer. Required if customer is not provided

email
string

The email of the customer. Required if customer is not provided

amount
number

The amount to send in the Favordrop. (Required - must be greater than or equal to $5)

expire_time
string <date-time>

The expiration time of the Favordrop. (Required)

send_at
string <date-time>

The time to send the Favordrop. (Required)

merchant
string

The unique identifier of the merchant.(Required)

message
string

The message to send with the Favordrop. (Optional)

valid_at
string <date-time>

The time the Favordrop is valid. (Optional)

on_redeem_followup_message
string

The message to send when the Favordrop is redeemed. (Optional)

send_type
Array of strings

The type of message to send. (Required - must be either sms, or email. For sms you must have a toll-free number on file for the organization)

cc_phones
Array of strings

The phone number to receive status updates about the favordrop. (Optional)

cc_emails
Array of strings

The email to receive status updates about the favordrop. (Optional)

reminder_message
string

The message to send as a reminder to redeem the favordrop. (Optional)

layout_id
string

The layout to use for the favordrop. (Optional)

sender_time_zone
string

The time zone of the sender. (Optional - defaults to America/New_York)

Responses

Request samples

Content type
application/json
{
  • "customer": "string",
  • "fname": "string",
  • "lname": "string",
  • "phone": "string",
  • "email": "string",
  • "amount": 0,
  • "expire_time": "2019-08-24T14:15:22Z",
  • "send_at": "2019-08-24T14:15:22Z",
  • "merchant": "string",
  • "message": "string",
  • "valid_at": "2019-08-24T14:15:22Z",
  • "on_redeem_followup_message": "string",
  • "send_type": [
    ],
  • "cc_phones": [
    ],
  • "cc_emails": [
    ],
  • "reminder_message": "string",
  • "layout_id": "string",
  • "sender_time_zone": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Get a list of all merchants

Use this endpoint to retrieve a list of all merchants.

Responses

Response samples

Content type
application/json
[
  • {
    }
]