Skip to main content
The Teams server (https://app.hoppier.com/api/mcp/business/v1) is for admins who run programs in the Hoppier dashboard. Your assistant picks the tools itself. This page tells you what each one can do.
  • Amounts are whole cents: 2500 is $25.00.
  • Every tool works on the one company the connection belongs to.
  • Every change takes an idempotency_key (a UUID), so a retried request never runs twice.
  • With approvals on (the default), changes wait for an admin to approve them. See Approvals and security.
  • If your account is billed by subscription, it needs an active one.

​
Reading

  • get_company_context: your company, the features turned on for admins, whether changes need approval, how many requests are waiting, and how many invitations are left. Never a money balance.
  • list_programs: your programs with participant counts. Filter by active, archived or all, and by program type. Up to 50 per page.
  • get_program: one program: its details, participant counts, the merchants it allows, and whether it can be topped up.
  • list_participants: a program’s participants, or one person by email, with whether each has activated their card. Up to 100 per page. Never returns invite or claim links.
  • get_action_status: the status of a change waiting for approval: pending, approved, executed, failed, rejected, expired or cancelled.
  • get_invite_email: a program’s two invite emails: the one sent as people are added, and the scheduled one.
  • search_merchant_catalog: searches Hoppier’s merchants and gift-card brands for ids to use in a program.

​
Changing things

  • create_program creates a one-time program. Limit: 5 per company per day.
  • add_participants adds people to a program. Limit: 1 to 50 people per call, and 50 invitations per company per day, top-ups included.
  • send_topup adds money to activated participants’ cards. Limit: $2,500 and 25 people per call, $10,000 per company per day, $25,000 per week.
  • update_invite_email edits a program’s invite email or its schedule.
  • resend_invites sends the invite email again to people who haven’t activated. Limit: 50 people per call, 200 per company per day.
  • update_program_merchants changes which merchants a program allows. Limit: 100 merchants per call, 20 changes per company per day.
These are the standard limits. If they get in your way, email support@hoppier.com.

​
create_program

  • Needs: a name, a program type (hoppier_card for a prepaid Visa card, or gift_card), and an amount per person in cents.
  • Options: a start date; either an end date, or an expiry that runs a set number of days or hours from when each person is added; individual amounts instead of a fixed one; the merchants it allows.
  • A Visa program needs your company’s card account to be verified. Without it, the program is created as a gift-card program and the assistant is told.
  • With no merchants given, the program uses your company template’s merchants. With neither, it allows every merchant, and the response says so.
  • The program type can’t be changed afterwards, and the amount locks once the program starts, so the assistant should confirm both with you first.
  • Needs permission to create programs, and a company address saved in the dashboard.

​
add_participants

  • Needs: the program, up to 50 people (email, and optionally first and last name), and notify: immediately, none or scheduled. The assistant must ask you which.
    • immediately emails each person their invite link as they’re added.
    • none adds them without an email.
    • scheduled adds them without an email and sets the program’s scheduled invite email. It goes to everyone in the program who hasn’t activated yet, not only the people added now.
  • On a program with individual amounts, each person needs an amount_cents (at least 100).
  • Each person uses one invitation from your plan. People already in the program are skipped.

​
send_topup

  • Adds the same amount to each person’s card: up to 25 activated participants per call. People who haven’t activated yet can’t be topped up; add them with add_participants instead.
  • It doesn’t charge anyone’s card. It raises the participant’s card balance and emails them, with an optional note from you. Each top-up uses one invitation from your plan.
  • Can be scheduled for later with send_at. Scheduled top-ups also count towards the daily and weekly limits.
  • Needs the card top-up feature for your company, and a one-time program.

​
update_invite_email

  • Edits one of the program’s two invite emails: the subject, the HTML body, and for the scheduled one, the send time.
  • The body must keep the __invite_url__ placeholder, which becomes each person’s invite link. Other placeholders: __first_name__, __company_name__, __card_value__, __start_date__, __end_date__, __event_name__.
  • The schedule is for the whole program: moving it moves the email for everyone who hasn’t activated yet.
  • The body is cleaned to email-safe HTML before it’s saved. With approvals on, the approver sees the email as it will look.

​
resend_invites

  • Sends the program’s invite email again to the participants you list, for example people who say they never got it. There’s no “everyone” option.
  • People who have already activated are skipped. Resends don’t use invitations.

​
update_program_merchants

  • Adds or removes merchants from a program, or lets it use every merchant with allow_all_merchants.
  • An empty list allows every merchant, so removing the last merchant is refused unless allow_all_merchants is set.
  • Visa programs take Visa merchants and gift-card programs take gift-card brands. Cards already issued for a Visa program pick up the change.
  • Not available when your company template fixes the merchants; change those in the dashboard.