Skip to main content
Givebutter logo
  • Category: fundraising
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 58
  • Triggers: 0
  • Slug: GIVEBUTTER
  • Version: 20261101_00

Tools

Slug: GIVEBUTTER_ADD_CONTACT_TAGSTool to add tags to a contact by contact ID. Use when you need to categorize or label contacts with specific tags.

Input Parameters

array
required
List of tags to add to the contact. Each tag must be 64 characters or less.
integer
required
The contact ID to add tags to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_ADD_HOUSEHOLD_CONTACTTool to add a contact to a household. Use when you have both a household ID and contact ID to associate them together.

Input Parameters

integer
required
The household ID to add the contact to.
integer
required
The contact ID to add to the household.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_ARCHIVE_CONTACTTool to archive a contact by their ID. Use after ensuring the contact has no associated data (e.g., no transactions or communications). Example: “Archive contact abc123”.

Input Parameters

string
required
Unique identifier of the contact to archive. The contact must have no associated data like transactions, recurring donations, auction bids, tickets, or communications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_CREATE_CAMPAIGNTool to create a new campaign. Use when you have title, description, goal, and type ready, after confirming your Givebutter account is authenticated.

Input Parameters

integer
Campaign goal amount in cents (e.g., $1000 -> 100000).
object
SEO meta tags for the campaign page.
string
Unique slug for the campaign; auto-generated if omitted.
string ("general" | "collect" | "fundraise" | "event")
required
Type of the campaign.
object
Banner image settings; include only when providing a cover.
string
required
Primary title of the campaign.
string
UTC datetime string when the campaign ends.
string
Currency code; only USD is currently supported.
string
Optional subtitle displayed under the title.
string
HTML content for the campaign description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_CREATE_CAMPAIGN_TICKETTool to create a campaign ticket for events or fundraisers. Use when you need to add ticket options to a campaign with pricing and inventory details.

Input Parameters

string
required
Name of the ticket (max 255 characters).
number
required
Price of the ticket in USD.
string ("registrant" | "event")
required
Scope of the ticket: ‘registrant’ (per person) or ‘event’ (per order).
boolean
Whether the ticket is active and available for purchase.
array
List of bundle IDs this ticket is associated with.
string ("physical" | "digital" | "hybrid")
required
Subtype of the ticket: physical, digital, or hybrid.
integer
required
The campaign ID where the ticket will be created.
array
List of picture URLs to display for the ticket.
boolean
Whether this ticket can only be purchased as part of a bundle.
string
Description of the ticket (max 5000 characters).
number
Original retail price for comparison (e.g., to show discounts).
array
List of custom field IDs to collect from ticket buyers.
boolean
Whether to hide the remaining ticket count from buyers.
integer
Total quantity of tickets available. If not specified, unlimited tickets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_CREATE_CONTACTTool to create a new contact in Givebutter. Use when you need to add a new contact with first name, last name, and optionally email, phone, and other details.

Input Parameters

string
Date of birth in YYYY-MM-DD format.
string
Additional notes about the contact.
string
Job title or position.
array
List of email addresses with types.
string
Gender of the contact.
array
List of phone numbers with types.
string
Name prefix (e.g., ‘Mr.’, ‘Ms.’, ‘Dr.’).
string
Name suffix (e.g., ‘Jr.’, ‘Sr.’, ‘III’).
string
Company or organization name.
string
Employer name.
string
Preferred pronouns (e.g., ‘he/him’, ‘she/her’, ‘they/them’).
array
List of addresses for the contact.
string
required
Last name of the contact.
string
required
First name of the contact.
string
TikTok profile URL.
string
External identifier from another system.
string
Middle name of the contact.
string
Twitter profile URL.
string
Personal or company website URL.
string
Full company name.
string
Facebook profile URL.
string
LinkedIn profile URL.
array
List of custom field values (id and value pairs).
string
Primary email address of the contact.
string
Primary phone number of the contact.
string
Preferred name or nickname.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_CREATE_CONTACT_ACTIVITYTool to create a contact activity (e.g., note). Use when you need to log an activity for a contact. Requires contact ID and activity details.

Input Parameters

string
required
The note content for the activity.
string
required
The type of activity (e.g., ‘note’).
integer
required
The contact ID to create the activity for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_CREATE_DISCOUNT_CODETool to create a discount code for a campaign. Use when you need to provide promotional pricing or discounts for campaign items.

Input Parameters

string
required
The discount code string that users will enter. Must be unique within the campaign and no more than 255 characters.
string ("percentage" | "fixed")
required
Type of discount: ‘percentage’ for a percentage-based discount (e.g., 10% off), or ‘fixed’ for a fixed amount discount (e.g., $10 off).
integer
Maximum number of times the discount code can be used. If not provided, there is no usage limit.
array
List of item IDs that the discount code applies to. If not provided, the code applies to all items in the campaign.
boolean
required
Whether the discount code is active and can be used immediately.
number
required
Discount amount. For ‘percentage’ type, this is the percentage (e.g., 10 for 10% off). For ‘fixed’ type, this is the amount in cents (e.g., 1000 for $10.00 off).
integer
required
The campaign ID to create the discount code for.
string
UTC datetime string when the discount code becomes active (ISO-8601 format). If not provided, the code is active immediately.
string
UTC datetime string when the discount code expires (ISO-8601 format). If not provided, the code will not expire.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_CREATE_FUNDTool to create a new fund. Use when you need to create a fund with a name and optional code.

Input Parameters

string
Optional unique code for the fund.
string
required
Name of the fund to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_CREATE_HOUSEHOLDTool to create a new household in Givebutter. Use when you need to group related contacts under a single household entity.

Input Parameters

string
required
Name of the household (required).
string
Additional notes about the household (optional).
string
Envelope name for the household (optional).
integer
ID of the contact designated as the head of the household (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_CREATE_TRANSACTIONTool to create a new transaction for a campaign. Use when you need to record a donation or payment, typically for offline transactions like cash or check payments.

Input Parameters

number
required
Transaction amount in dollars (e.g., 25.00 for $25).
integer
required
ID of the contact who made this transaction. Must be a valid integer referencing an existing contact.
string
Campaign code to credit this transaction to. Required if campaign_title is not provided. Either campaign_code or campaign_title must be specified.
string
required
UTC datetime when the transaction occurred in ISO 8601 format (e.g., ‘2026-02-13T15:30:00Z’). Must be a date before now.
string
Campaign title to credit this transaction to. Required if campaign_code is not provided. Either campaign_code or campaign_title must be specified.
string
required
Payment method used for the transaction. Common values include ‘cash’, ‘check’, ‘card’, ‘paypal’, ‘venmo’, ‘ach’, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_CREATE_WEBHOOKTool to create a new webhook subscription. Use when you need to receive real-time notifications programmatically after confirming your endpoint can validate Givebutter’s signing secret.

Input Parameters

string
required
The HTTPS endpoint URL that will receive webhook payloads.
string
required
A friendly name for the webhook subscription.
array
required
List of event types that will trigger this webhook subscription.
boolean
Whether the webhook is active immediately upon creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_DELETE_CAMPAIGNTool to delete a campaign by its ID. Use after confirming the campaign has no funds raised. Example: “Delete campaign abc123”.

Input Parameters

string
required
Unique identifier of the campaign to delete. Cannot delete if the campaign has any funds raised.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_DELETE_CONTACT_ACTIVITYTool to delete a contact activity by contact ID and activity ID. Use when you need to remove a specific activity from a contact’s record.

Input Parameters

integer
required
The contact ID
integer
required
The activity ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_DELETE_DISCOUNT_CODETool to delete a discount code from a campaign. Use when you need to remove a discount code after confirming it exists.

Input Parameters

integer
required
The campaign ID that the discount code belongs to.
integer
required
The discount code ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_DELETE_FUNDTool to delete a fund by its ID. Use when you need to remove a fund after confirming it exists. Example: “Delete fund fund_abc123”.

Input Parameters

string
required
Unique identifier of the fund to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_DELETE_HOUSEHOLDTool to delete a household by its ID. Use after confirming the household exists and has no associated data. Example: “Delete household 1007067”.

Input Parameters

integer
required
Unique identifier of the household to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_DELETE_WEBHOOKTool to delete a webhook by its ID. Use when you need to remove an obsolete webhook after confirming no further events are needed. Example: “Delete webhook abc123”.

Input Parameters

string
required
Unique identifier of the webhook to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_CAMPAIGNTool to retrieve details for a specific campaign by its ID or code. Use when you need to fetch campaign information, check status, or get fundraising progress.

Input Parameters

string
required
Campaign ID or code to retrieve. Can be numeric ID or campaign slug/code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_CAMPAIGN_TICKETTool to retrieve a specific campaign ticket by campaign ID and ticket ID. Use when you need details about a specific ticket item within a campaign.

Input Parameters

integer
required
The campaign ID
integer
required
The ticket ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_CONTACTTool to retrieve details of a specific contact by ID. Use after confirming the contact ID is valid.

Input Parameters

integer
required
Unique identifier of the contact to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_CONTACT_ACTIVITYTool to retrieve a specific contact activity by contact ID and activity ID. Use when you need detailed information about a particular activity for a contact.

Input Parameters

integer
required
The contact ID
integer
required
The activity ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_DISCOUNT_CODETool to retrieve details of a specific discount code for a campaign. Use when you need to view discount code information.

Input Parameters

integer
required
The campaign ID
integer
required
The discount code ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_FUNDTool to retrieve details of a specific fund by its ID. Use after confirming the fund ID is valid.

Input Parameters

string
required
Unique identifier of the fund to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_HOUSEHOLDTool to retrieve details of a specific household by its ID. Use when you need information about a household including its contacts.

Input Parameters

integer
required
The household ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_MEMBERSTool to retrieve a paginated list of members for a given campaign. Use when you need to list or process campaign members.

Input Parameters

integer
Page number for pagination, must be >= 1
string
required
Unique identifier of the campaign to retrieve members from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_PAYOUTSTool to retrieve a list of payouts associated with your account. Use when you need to list withdrawal transactions after authentication.

Input Parameters

integer
Page number for pagination, must be >= 1.
integer
Number of payouts to return per page, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_PLANSRetrieve recurring donation plans associated with the authenticated Givebutter account. Specify a page and page size to browse additional results; retrieve multiple pages to assemble the full list.

Input Parameters

integer
Page number for pagination, must be >= 1.
integer
Number of plans to return per page, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_TEAMSTool to retrieve a list of teams for a specific campaign. Use after creating or updating a campaign when you need to list fundraising teams. Example: “Get teams for campaign camp123”.

Input Parameters

string
required
Unique identifier of the campaign whose teams to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_TICKETSRetrieve a list of tickets for your account. When the API response is paginated, the tool returns only the tickets in that response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_TRANSACTIONSRetrieve a page of account transactions, optionally filtered by scope. The response contains the transactions from that page without pagination metadata.

Input Parameters

integer
Page number for pagination, must be >= 1.
integer
Number of transactions to return per page, must be >= 1.
string ("account" | "beneficiary" | "chapter")
Scope of transactions to retrieve: ‘account’ (default), ‘beneficiary’, or ‘chapter’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_WEBHOOKTool to retrieve a specific webhook by its ID. Use when you need details about a single webhook subscription.

Input Parameters

string
required
The unique identifier of the webhook to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_WEBHOOK_ACTIVITYTool to retrieve a specific webhook activity by its ID. Use when you need detailed information about a single webhook delivery event.

Input Parameters

string
required
The webhook ID to retrieve the activity from.
string
required
The activity ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_GET_WEBHOOKSRetrieve a page of webhooks configured for your account. The response contains the webhooks from that page without pagination metadata.

Input Parameters

integer
Page number for pagination, must be >= 1.
integer
Number of webhooks to return per page, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_CAMPAIGNSTool to retrieve a paginated list of campaigns for the authenticated account. Use when you need to list all campaigns.

Input Parameters

integer
Page number to retrieve. Default: 1.
string
Optional scope parameter to filter campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_CAMPAIGN_TICKETSRetrieve a paginated list of tickets for a specific campaign.

Input Parameters

integer
Page number to retrieve. Default: 1.
integer
required
The campaign ID to retrieve tickets from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_CONTACT_ACTIVITIESRetrieve a paginated list of activities for a specific contact, optionally filtered by activity type.

Input Parameters

integer
Page number to retrieve. Default: 1.
string ("archived" | "campaign.joined" | "email" | "email.subscribed" | "email.unsubscribed" | "letter" | "meeting" | "note" | "phone_call" | "recurring_plan.canceled" | "recurring_plan.created" | "recurring_plan.activated" | "signup_form.submitted" | "sms" | "sms.subscribed" | "sms.unsubscribed" | "subscription_form.submitted" | "completed_task" | "ticket.issued" | "transaction.recieved" | "transaction.succeeded" | "transaction.acknowledged" | "transaction.unacknowledged" | "unarchived" | "volunteer_activity" | "soft_credited")
Enum for activity types
integer
required
The contact ID to retrieve activities for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_CONTACTSTool to retrieve a paginated list of contacts from your Givebutter account. Use when you need to list all contacts with optional filtering by type, date ranges, contribution amounts, tags, or sorting preferences.

Input Parameters

integer
Page number to retrieve. Default: 1.
string
Filter contacts by tags (comma-separated).
string ("individual" | "company")
Contact type enumeration
string ("name_or_company" | "primary_email" | "point_of_contact" | "created_at" | "total_contributions" | "recurring_contributions" | "last_donation_amount")
Sort by field enumeration
string ("name_or_company" | "primary_email" | "point_of_contact" | "created_at" | "total_contributions" | "recurring_contributions" | "last_donation_amount")
Sort by field enumeration
string
Filter contacts created after this date (ISO 8601 format).
string
Filter contacts updated after this date (ISO 8601 format).
string
Filter contacts created before this date (ISO 8601 format).
string
Filter contacts updated before this date (ISO 8601 format).
number
Filter contacts with total contributions less than or equal to this amount.
number
Filter contacts with total contributions greater than or equal to this amount.
number
Filter contacts with recurring contributions less than or equal to this amount.
number
Filter contacts with recurring contributions greater than or equal to this amount.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_DISCOUNT_CODESList discount codes for a campaign, including active and inactive codes, in paginated results.

Input Parameters

integer
Page number to retrieve. Default: 1.
integer
required
The campaign ID to retrieve discount codes for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_FUNDSTool to list all funds in your Givebutter account. Returns paginated results with up to 20 funds per page. Use when you need to retrieve multiple funds or browse all available funds.

Input Parameters

integer
Page number for pagination (1-indexed). Defaults to page 1 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_HOUSEHOLD_CONTACTSRetrieve a paginated list of contacts associated with a household by its ID. Use the page parameter to navigate results.

Input Parameters

integer
Page number to retrieve. Default: 1.
integer
required
The household ID to retrieve contacts for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_HOUSEHOLDSRetrieve a page of households in your account, including associated contacts. Use the page parameter to request other pages.

Input Parameters

string
Page number for pagination. Defaults to 1 if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_MESSAGESTool to retrieve a paginated list of messages. Use when you need to list messages sent through your Givebutter account. Returns paginated results; use the page parameter to navigate through pages.

Input Parameters

integer
Page number for pagination (1-indexed). Defaults to page 1 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_PLEDGESTool to retrieve a paginated list of all pledges. Use when you need to list pledges with optional pagination support.

Input Parameters

integer
Page number for pagination (1-indexed). Each page returns up to 20 results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_LIST_WEBHOOK_ACTIVITIESList a page of activity logs for a specific webhook subscription, with pagination links and metadata.

Input Parameters

integer
Page number to retrieve. Default: 1.
string
required
The webhook ID to list activities for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_REMOVE_CONTACT_TAGSTool to remove tags from a contact in Givebutter. Use when you need to disassociate specific tags from a contact record. Requires the contact ID and a list of tag names to remove.

Input Parameters

array
required
List of tag names to remove from the contact. Each tag must be 64 characters or less.
integer
required
The contact ID from which to remove tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_RESTORE_CONTACTTool to restore a deleted contact by contact ID. Use when you need to recover a contact that was previously deleted.

Input Parameters

integer
required
The contact ID to restore from deleted state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_SYNC_CONTACT_TAGSTool to sync tags for a contact. Replaces all existing tags with the specified tags. Use when you need to update the complete tag list for a contact.

Input Parameters

array
required
List of tag names to sync for this contact. Replaces all existing tags with the specified tags. Each tag must be 64 characters or less.
integer
required
The contact ID to sync tags for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_UPDATE_CAMPAIGNTool to update an existing campaign’s details by its ID. Use when you need to modify campaign attributes after creation.

Input Parameters

integer
Campaign goal amount in cents (e.g., $10.00 -> 1000).
object
SEO meta tags for the campaign page.
string
Unique slug for the campaign; auto-generated if omitted.
string ("general" | "collect" | "fundraise" | "event")
Type of the campaign.
object
Banner image settings; include only when updating the cover.
string
Primary title of the campaign.
string
UTC datetime string when the campaign ends (e.g., ‘2024-12-31T23:59:59Z’).
string
Currency code; only USD is currently supported.
string
Optional subtitle displayed under the title.
string
required
Unique identifier of the campaign to update.
string
HTML content for the campaign description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_UPDATE_CAMPAIGN_PUTTool to update a campaign using PUT method. Use when you need to update campaign details like title, description, goal, or other attributes.

Input Parameters

integer
Campaign goal amount in cents (e.g., $10.00 -> 1000).
object
SEO meta tags for the campaign page.
string
Unique slug for the campaign; auto-generated if omitted.
string ("general" | "collect" | "fundraise" | "event")
Type of the campaign.
object
Banner image settings; include only when updating the cover.
string
Primary title of the campaign.
string
UTC datetime string when the campaign ends (e.g., ‘2024-12-31T23:59:59Z’).
integer
required
The campaign ID to update.
string
Currency code; only USD is currently supported.
string
Optional subtitle displayed under the title.
string
HTML content for the campaign description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_UPDATE_CONTACTTool to update an existing contact’s details by contact ID. Use when modifying contact information after confirming the contact_id. Only provided fields will be updated.

Input Parameters

string
Email address of the contact.
string
Phone number of the contact.
object
Address details to update
string
required
Last name of the contact (required by the API).
string
required
ID of the contact to update.
string
required
First name of the contact (required by the API).
array
List of custom field updates (id and new value).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_UPDATE_CONTACT_ACTIVITYTool to update a contact activity by contact ID and activity ID. Use when modifying an existing contact activity record.

Input Parameters

string
The note content for the activity.
string
The type of activity (e.g., ‘note’, ‘email’, ‘phone_call’, ‘meeting’, ‘sms’, ‘completed_task’, ‘volunteer_activity’).
integer
required
The contact ID.
string
The subject of the activity (not required for note events).
integer
required
The activity ID.
string
When the activity occurred (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_UPDATE_CONTACT_PUTTool to update a contact using PUT method. Use when you need to update contact information by contact ID.

Input Parameters

string
Date of birth in YYYY-MM-DD format
string
Notes about the contact
string
Job title
array
List of email addresses
string
Gender of the contact
array
List of phone numbers
string
Name prefix (e.g., Mr., Mrs., Dr.)
string
Name suffix (e.g., Jr., Sr.)
integer
required
The contact ID to update
string
Employer name
string
Preferred pronouns
array
List of addresses
string
required
Last name of the contact (required by API)
string
required
First name of the contact (required by API)
string
TikTok profile URL
string
Middle name of the contact
string
Twitter profile URL
string
Website URL
string
Facebook profile URL
string
LinkedIn profile URL
string
Preferred name of the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_UPDATE_DISCOUNT_CODEUpdate an existing campaign discount code, including its expiration or usage limits. An amount is required for every update.

Input Parameters

string
The discount code string that users will enter.
string ("percentage" | "fixed")
Discount code type
number
Maximum number of times this discount code can be used. If null, unlimited uses.
array
List of item IDs that this discount code applies to. If null or empty, applies to all items.
boolean
Whether the discount code is active and can be used.
number
required
The discount amount. For percentage type, this is a value between 1-100. For fixed type, this represents the discount amount in cents (e.g., 1500 for $15.00).
integer
required
The campaign ID to update the discount code for.
string
UTC datetime string when the discount code becomes active (ISO 8601 format).
string
UTC datetime string when the discount code expires (ISO 8601 format).
integer
required
The discount code ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_UPDATE_FUNDTool to update a fund’s details by its ID. Use when you need to modify fund attributes such as name or code.

Input Parameters

string
Optional code for the fund. Can be null.
string
Name of the fund. Required if updating the fund name.
string
required
Unique identifier (fid) of the fund to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_UPDATE_HOUSEHOLDTool to update an existing household’s details by its ID. Use when you need to modify household information after confirming the household_id.

Input Parameters

string
Name of the household.
string
Additional notes about the household.
integer
required
Unique identifier of the household to update.
string
Envelope name for the household.
integer
ID of the contact who is the head of the household.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_UPDATE_WEBHOOKUpdate a webhook subscription by ID, supplying its URL and trigger events and optionally changing its name or enabled state.

Input Parameters

string
required
Unique identifier of the webhook to update
string
required
The HTTPS endpoint URL that will receive webhook payloads. Required by the API.
string
New friendly name for the webhook subscription.
array
required
List of event types that will trigger this webhook subscription. Required by the API. Available: campaign.created, campaign.updated, ticket.created, transaction.succeeded, contact.created, plan.canceled, plan.created, plan.resumed, plan.updated
boolean
Whether the webhook is active (true) or disabled (false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GIVEBUTTER_UPDATE_WEBHOOK_PUTTool to update a webhook using PUT method (full replacement). Use when you need to completely replace a webhook’s configuration.

Input Parameters

string
required
The HTTPS endpoint URL that will receive webhook payloads
string
Optional friendly name for the webhook
array
required
List of event types that will trigger this webhook. Available: campaign.created, campaign.updated, ticket.created, transaction.succeeded, contact.created, plan.canceled, plan.created, plan.paused, plan.resumed, plan.updated
boolean
Whether the webhook is active (true) or disabled (false)
string
required
The webhook ID to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not