Connect Claude & ChatGPT to Roster

105 tools for Roster

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

• add_program_ambassadorsChanges dataAdd one or more contacts (`contact_ids`) as ambassadors to a program by `program_id`. May email them unless `suppress_email` is true.
• approve_cash_rewardVisible to othersApprove a cash reward. Has effects visible outside this system. API summary: Approves pending cash rewards. Approving does not pay them - payment happens in a batch.
• approve_referral_rewardVisible to othersApprove a referral reward. Has effects visible outside this system. API summary: Approves pending referral rewards.
• archive_discount_codeVisible to othersDeactivate a discount code (discount code id). Has effects visible outside this system. API summary: Deactivate an ambassador’s discount code.
• archive_discount_ruleVisible to othersArchive a discount rule (discount rule id). Has effects visible outside this system. API summary: Archive an expired discount rule. Deactivates all codes and queues Shopify cleanup if applicable.
• create_assignedChanges dataCreate a new assigned. Required: codes. API summary: Import a batch of assigned discount codes into a discount rule.
• create_cash_rewardChanges dataCreate a new cash reward. API summary: Creates a manual cash reward - money owed for work with no campaign or milestone behind it.
• create_channelChanges dataCreate a new channel. Search channels first to avoid duplicates. API summary: Creates a channel.
• create_clickChanges dataCreate a new click. API summary: Creates a link click.
• create_contactChanges dataCreate a contact with `email` and `first_name`, plus optional last name, phone, birth date, social handles and tags (comma-separated).
• create_contact_propertyChanges dataCreate a new property for a contact. Required: property value or property id. API summary: Sets a property for a contact.
• create_discount_codeChanges dataCreate a discount `code` under a discount rule (`discount_rule_id`) and assign it to an ambassador (`ambassador_id`).
• create_likeChanges dataCreate a new like. API summary: Creates a like for a post or comment.
• create_messageChanges dataCreate a new message. API summary: Creates a comment for a post or comment.
• create_orderChanges dataCreate a new order. Required: external order id, order date, currency or total price. API summary: Creates an order.
• create_pageChanges dataCreate a new page. Required: channel id, status or user id. Search pages first to avoid duplicates. API summary: Creates a post.
• create_program_applicantChanges dataCreate a new applicant for a program. Required: email. API summary: Add a new applicant to a program.
• create_referral_rewardChanges dataCreate a new referral reward. Required: order details or ambassador id. API summary: Creates a pending manual referral reward.
• create_unassignedChanges dataCreate a new unassigned. Required: codes. API summary: Import a batch of unassigned discount codes into a discount rule.
• create_undoChanges dataCreate a new undo. API summary: Sets approved or rejected cash rewards back to pending.
• create_undo_postChanges dataCreate a new undo. API summary: Sets approved or rejected referral rewards back to pending.
• create_webhookDeletesCreate a new webhook. Destructive action; may require approval. API summary: Creates a new webhook.
• delete_channel_participantsMoves moneyPermanently delete a participant by channel id. Financial or irreversible action; may require approval. API summary: Removes participants from a channel.
• delete_contactDeletesPermanently delete a contact by contact id. Destructive action; may require approval. API summary: Deletes a single contact.
• delete_contact_propertyDeletesPermanently delete a property by property id. Destructive action; may require approval. API summary: Deletes a property from a contact.
• delete_discount_ruleDeletesPermanently delete a discount rule by discount rule id. Destructive action; may require approval. API summary: Delete a discount rule that doesn’t have any assigned codes or isn’t linked to another object.
• delete_discount_rule_unassignedsMoves moneyPermanently delete a unassigned by discount rule id. Financial or irreversible action; may require approval. API summary: Delete unassigned discount codes in a discount rule.
• delete_likeDeletesPermanently delete a like by like id. Destructive action; may require approval. API summary: Deletes a like from a post or comment.
• delete_pageDeletesPermanently delete a page by page id. Destructive action; may require approval. API summary: Deletes a post and all child records.
• delete_program_ambassadorsMoves moneyPermanently delete a ambassador by program id. Financial or irreversible action; may require approval. API summary: Remove an ambassador from a program.
• delete_reward_templateDeletesPermanently delete a reward template by reward template id. Destructive action; may require approval. API summary: Deletes a reward template.
• delete_webhookDeletesPermanently delete a webhook by webhook id. Destructive action; may require approval. API summary: Deletes an existing webhook.
• find_contactsFind contacts by exact `email`, `instagram_handle`, `referral_link_id` or a list of `contact_ids`.
• get_accountGet details of the connected Roster brand account. Use to confirm which account you are working in.
• get_attributionGet one attribution by attribution id. API summary: Retrieves a single attribution.
• get_campaign_performanceGet performance figures for a campaign by `campaign_id`.
• get_channelGet one channel by channel id. API summary: Retrieves a specific channel.
• get_contactGet one contact by `contact_id`, with profile, tags and social handles.
• get_contact_performanceGet performance figures for one contact by `contact_id`, such as referrals and sales.
• get_contact_propertyGet one property for a contact by property id. API summary: Retrieves a specific property for a contact.
• get_discount_codeGet one discount code by discount code id. API summary: Retrieves a specific discount code.
• get_discount_ruleGet one discount rule by discount rule id. API summary: Retrieves a specific discount rule.
• get_eventGet one event by event id. API summary: Retrieves a specific event.
• get_import_statusGet the current status of a import. API summary: Checks if the brand has an active contact import job.
• get_messageGet one message by message id. API summary: Retrieves a specific comment.
• get_orderGet one order by Roster `order_id`, with totals, line items and attribution.
• get_pageGet one page by page id. API summary: Retrieves a specific post.
• get_programGet one ambassador program by `program_id`.
• get_program_applicantGet one program applicant by `program_id` and `applicant_id` (contact ID), including their application.
• get_program_performanceGet dashboard performance figures for a program by `program_id` over a date range (default the last 30 days).
• get_referral_rewardGet one referral reward by `referral_reward_id`.
• get_rewardGet one reward by `reward_id`.
• get_reward_templateGet one reward template by reward template id. API summary: Retrieves a specific reward template.
• get_sales_attribution_reportReport referred revenue, clicks, new customers and orders per ambassador over a date range, filterable by program or tag.
• get_webhookGet one webhook by webhook id. API summary: Retrieves a specific webhook.
• list_application_formsList application forms. API summary: Retrieves the application form definition for a program.
• list_attributionsList attributions. Optional filters: ambassador ids, program ids, tag ids, order id, external order number or attribution type. Results are paginated. API summary: Retrieves a list of all attributions.
• list_campaign_participantsList the participants of a campaign by `campaign_id`, filtered by participation `status`.
• list_campaign_rewardsList rewards for a campaign. Optional filters: ambassador, type, status, cash status, campaign reward issuance or reward ids. Results are paginated. API summary: Retrieves a list of all campaign rewards.
• list_cash_rewardsList cash rewards, filtered by ambassador, source, status or date earned.
• list_channel_participantsList participants for a channel. Optional filters: contact ids, program ids, sort field or sort direction. Results are paginated. API summary: Retrieves a list of a channel’s participants.
• list_clicksList clicks. Optional filters: ambassador id, referral link id, created at min or created at max. Results are paginated. API summary: Retrieves a list of all clicks.
• list_contact_propertiesList properties for a contact. Results are paginated. API summary: Retrieves a list of a contact’s properties.
• list_eventsList events. Optional filters: subject type, verb, subject id, since id, created at min or created at max. Results are paginated. API summary: Retrieves a list of all events.
• list_likesList likes. Optional filters: parent id, parent type, user id, sort field or sort direction. Results are paginated. API summary: Retrieves a list of likes.
• list_mesList mes. API summary: Retrieves a profile.
• list_messagesList messages. Optional filters: parent id, parent type, user id, sort field or sort direction. Results are paginated. API summary: Retrieves a list of comments.
• list_milestone_series_participantsList participants for a milestone series. Optional filters: ambassador ids, program ids, current milestone ids, sort field or sort direction. Results are paginated. API summary: Retrieves a list of milestone series participants.
• list_milestone_series_rewardsList rewards for a milestone series. Optional filters: ambassador, milestone, program, status, cash status or type. Results are paginated. API summary: Retrieves a list of milestone rewards.
• list_ordersList orders, filtered by customer, customer email, discount code or date range. Use to see referred sales.
• list_pagesList pages. Optional filters: ambassador ids, program ids, campaign ids, tag ids, networks or from date. Results are paginated. API summary: Retrieves the Social Posts report: grand totals plus one row per ambassador who posted in the date range (post and story counts, reach, impr….
• list_pages_getList pages. Optional filters: networks, program ids, contact id, from date, to date or sort. Results are paginated. API summary: Recent individual posts where ambassadors mentioned the brand — the portal's Social Feed: post URL and media, caption, platform, post type,….
• list_program_ambassadorsList the ambassadors in a program by `program_id`, optionally filtered by contact IDs or date added.
• list_program_applicantsList applicants to a program by `program_id`, filtered by `status` (pending, nominated, approved, rejected, removed).
• list_programsList ambassador programs, optionally filtered by `status` (active, archived).
• list_referral_rewardsList referral rewards (commission or points), filtered by program, ambassador or `reward_status` (pending, approved, paid, rejected).
• list_reward_template_rewardsList rewards for a reward template. Optional filters: ambassador, status, cash status, created at min, created at max or sort field. Results are paginated. API summary: Retrieves the list of rewards for a reward template.
• list_rewardsList rewards (products, discount codes, points, commission) filtered by `type`, `source` or fulfillment `status`.
• list_sample_csvsList sample csvs. API summary: Downloads a sample CSV template for contact imports.
• list_summariesList summaries. Optional filters: ambassador id, reward status, source, earned at min or earned at max. API summary: Retrieves the cash-only summary totals for the ledger. Never combined with points.
• list_webhooksList webhooks. Optional filters: address, topic, created at min or created at max. Results are paginated. API summary: Retrieves a list of all webhooks.
• lookup_discount_codeLook up a discount code by its `code` text to see who owns it and its rule.
• pay_clickMoves moneyCapture a click. Financial or irreversible action; may require approval. API summary: Creates a click using a public access token.
• pay_orderMoves moneyCapture a order. Financial or irreversible action; may require approval. API summary: Creates an order using a public access token.
• reject_cash_rewardVisible to othersReject a cash reward. Has effects visible outside this system. API summary: Rejects pending cash rewards.
• reject_referral_rewardVisible to othersReject a referral reward. Has effects visible outside this system. API summary: Rejects pending referral rewards.
• search_campaignsSearch campaigns by name in `query`, filtered by `status` or `type`.
• search_channelsSearch channels by program, status, search text, created at min, created at max or sort field. Use this to find existing channels before creating a new channel. Results are paginated. API summary: Retrieves a list of channels.
• search_contactsSearch contacts (ambassadors and customers) by free text in `query` over names, emails and social handles, with optional sorting.
• search_discount_rule_discount_codesSearch discount codes for a discount rule by query, ambassador, status, code ids, sort field or sort direction. Use this to find existing discount codes before creating a new discount code. Results are paginated. API summary: Retrieves a list of discount codes for a discount rule.
• search_discount_rulesSearch discount rules by `query`, filtered by `status` or type. Use to find a rule's ID before creating codes.
• search_pagesSearch pages by channel ids, status, user ids, search text, pinned filter or sort field. Use this to find existing pages before creating a new page. Results are paginated. API summary: Retrieves a list of posts.
• search_reward_templatesSearch reward templates by query, ambassador ids, reward types, action required options, created at min or created at max. Use this to find existing reward templates before creating a new reward template. Results are paginated. API summary: Retrieves a list of reward templates.
• set_reward_statusChanges dataSet the fulfillment `status` (fulfilled, pending, willNotFulfill, notRedeemed) of one or more `reward_ids`. With `notify` true and status fulfilled, emails the ambassadors.
• update_cash_rewardChanges dataUpdate an existing cash reward identified by cash reward id. API summary: Edits a manual cash reward while it is still Pending. A separate route from the create POST because the two enforce different preconditions;….
• update_channelChanges dataUpdate an existing channel identified by channel id. API summary: Updates a channel.
• update_channel_programsVisible to othersUpdate an existing program identified by channel id. Has effects visible outside this system.
• update_contactVisible to othersUpdate a contact by `contact_id`: name, email, phone, birth date or social handles, and add or remove tags. Only the fields you pass change.
• update_contact_propertyChanges dataUpdate an existing property identified by property id. API summary: Updates a property for a contact.
• update_mesVisible to othersUpdate an existing me. Has effects visible outside this system. API summary: Updates a profile.
• update_orderChanges dataUpdate an existing order identified by order id. API summary: Updates an order.
• update_pageChanges dataUpdate an existing page identified by page id. API summary: Updates a post.
• update_referral_rewardChanges dataUpdate an existing referral reward identified by referral reward id. API summary: Updates a pending manual referral reward.
• update_webhookDeletesUpdate an existing webhook identified by webhook id. Destructive action; may require approval. API summary: Updates an existing webhook.
• upload_contactChanges dataImport a contact. API summary: Creates a new contact import job.

Questions