# Raisely Documentation > Raisely's REST API lets you make your charity fundraising campaigns even more awesome. Start syncing, creating and updating your profiles, supporters and donations. ## Guides - [Modifying your campaign programatically](https://developers.raisely.com/docs/modifying-your-campaign-programatically.md) - [Theming Mixins](https://developers.raisely.com/docs/theme-style-mixins.md) - [About Webhooks](https://developers.raisely.com/docs/about-webhooks.md): Receiving notifications of activity on your campaign through Raisely's webhooks. - [Available Events](https://developers.raisely.com/docs/available-events.md): The full list of events Raisely can notify you about via our webhooks. ## API Reference - [get all](https://developers.raisely.com/reference/getauthenticate.md): Authenticate a token to confirm it's valid, check the logged-in user, or confirm token privileges. You can use /authenticate to find the organisation UUID of the token you are using, which may be useful in future requests. #### For custom components: `RaiselyComponents.api.all('authenticate').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [register](https://developers.raisely.com/reference/postcampaignsregister.md): Registers a user and creates a fundraisng profile for them and also (optionally)" creates or adds them to a team, makes a donation or registration fee. If creation is successful, the response will include a token and accessToken However, if a user with that email already exists in the campaign, the user will be sent an email to confirm that they want to add the profile to their account. The records are created simultaneously in full or not at all. If there is a problem with the donation or profile, then all records will not be created. The exception is for donations. If the Stripe gateway is using the PAYMENT_INTENT method, then the donation must already be created to facilitate payment, the donation is completed (or fails) as part of the registration. If the registration is successful, the donation record will be assigned to the profile once it's created. #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').all('register').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [check user](https://developers.raisely.com/reference/postcheckuser.md): Check if a user is already registered to this campaign with a specific email address. This is useful for validation in a sign-up form to prompt an existing user to log in. #### For custom components: `RaiselyComponents.api.all('check-user').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [login](https://developers.raisely.com/reference/postlogin.md): Exchange an email and password for a token used for future requests. This endpoint can be used by admin or participant accounts. If you're logging in a participant, an organisationUuid must be present in the body. #### For custom components: `RaiselyComponents.api.all('login').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [logout](https://developers.raisely.com/reference/postlogout.md): Invalidate the token used by this request #### For custom components: `RaiselyComponents.api.all('logout').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [signup](https://developers.raisely.com/reference/postsignup.md): Sign up a new user to your campaign. If the user you are registering is unknown you'll receive a token for the new user to use for future authenticated requests. If the user already exists in your organisation's database, they will be sent the Account Confirmation email and the API will return a human-friendly message.
_Note: Using /signup won't create a fundraising profile. You can create a profile later, or you can use /register. We recommend using /register when signing up a new fundraiser to a campaign._ #### For custom components: `RaiselyComponents.api.all('signup').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [magic link](https://developers.raisely.com/reference/postusersmagiclink.md): Request a magic link email for passwordless login. If the email matches an existing user, a magic link email will be sent. The response is always generic to prevent user enumeration. #### For custom components: `RaiselyComponents.api.all('users').all('magic-link').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [remove campaign](https://developers.raisely.com/reference/deletecampaign.md): Deletes the campaign #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').delete(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get campaign](https://developers.raisely.com/reference/getcampaign.md): Retrieve a specific **campaign**. #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getcampaigns.md): Returns a list of campaigns you've previously created. The campaigns will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.all('campaigns').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all donations](https://developers.raisely.com/reference/getcampaignsdonations.md): Returns a list of donations you've previously created. The donations will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').get('donations', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get campaign profile](https://developers.raisely.com/reference/getcampaignsprofile.md): Return the campaign profile

The campaign profile is the top level profile for all profiles in the campaign. It is hidden from the fundraising website, but will have the same name, path, and goal as your campaign. All profiles that don't otherwise belong to a team belong to the campaign profile, and their `parentUuid` field will refer to the campaign profile. #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').get('profile', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all profiles](https://developers.raisely.com/reference/getcampaignsprofiles.md): Returns all fundraising profiles in a campaign #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').get('profiles', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all subscriptions](https://developers.raisely.com/reference/getcampaignssubscriptions.md): Returns a list of subscriptions you've previously created. The subscriptions will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').get('subscriptions', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update campaign](https://developers.raisely.com/reference/patchcampaign.md): Updates the campaign with the new data #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update config](https://developers.raisely.com/reference/patchcampaignsconfig.md): Update a subkey of the config. This will overwrite the entire value of the key #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').one('config', '{attribute}').patch('{attribute}', data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add campaign](https://developers.raisely.com/reference/postcampaigns.md): Create a new or cloned campaign #### For custom components: `RaiselyComponents.api.all('campaigns').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [restore](https://developers.raisely.com/reference/postcampaignsrestore.md): Restores the campaign #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').all('restore').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all designations](https://developers.raisely.com/reference/getcampaignsdesignations.md): Returns designations associated with a campaign, ordered by sortOrder. #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').get('designations', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getdesignations.md): Returns a list of designations you've previously created. The designations will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.all('designations').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [remove donation](https://developers.raisely.com/reference/deletedonation.md): Delete a donation record. Only possible for OFFLINE donations. #### For custom components: `RaiselyComponents.api.one('donations', '{uuid}').delete(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get donation](https://developers.raisely.com/reference/getdonation.md): Retrieve a specific **donation**. #### For custom components: `RaiselyComponents.api.one('donations', '{uuid}').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getdonations.md): Returns a list of donations you've previously created. The donations will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.all('donations').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all receipts](https://developers.raisely.com/reference/getdonationsreceipts.md): Returns a list of the receipts attached to this donation #### For custom components: `RaiselyComponents.api.one('donations', '{uuid}').get('receipts', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update donation](https://developers.raisely.com/reference/patchdonation.md): Update the specified donation #### For custom components: `RaiselyComponents.api.one('donations', '{uuid}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [move](https://developers.raisely.com/reference/patchdonationsmove.md): Move a donation to a different profile (the profile may be located in a different campaign) #### For custom components: `RaiselyComponents.api.one('donations', '{uuid}').patch('move', data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add donation](https://developers.raisely.com/reference/postdonations.md): Record a donation processed elsewhere in Raisely. These donations are recorded with a type of `OFFLINE` in Raisely to indicate they were processed externally. **Note:** Adding an offline donation does not automatically send a receipt. You need to call the `resend` API to issue a receipt for an offline donation after it has been added to Raisely. #### For custom components: `RaiselyComponents.api.all('donations').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [match](https://developers.raisely.com/reference/postdonationsmatch.md): Match a donation using the specified matched giving configuration #### For custom components: `RaiselyComponents.api.one('donations', '{uuid}').all('match').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [resend](https://developers.raisely.com/reference/postdonationsresend.md): Send, or re-send, a donation receipt. If the donation was already receipted in Raisely, calling this API will mark the previous receipt as void and re-issue a new receipt. Optionally include an email in the API payload to send the receipt to an alternate email address, without updating the donation record. **Offline Donations** If you have added an offline donation, Raisely (out of an abundance of caution) doesn't automatically send a receipt. Calling this API after you've added an offline donation will trigger a receipt to be generated and sent to the donor. #### For custom components: `RaiselyComponents.api.one('donations', '{uuid}').all('resend').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [remove exercise log](https://developers.raisely.com/reference/deleteexerciselog.md): Delete the specified **exercise log**. #### For custom components: `RaiselyComponents.api.one('exercise-logs', '{uuid}').delete(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get exercise log](https://developers.raisely.com/reference/getexerciselog.md): Retrieve a specific **exercise log**. #### For custom components: `RaiselyComponents.api.one('exercise-logs', '{uuid}').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getexerciselogs.md): Returns a list of exercise logs you've previously created. The exercise logs will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.all('exercise-logs').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update exercise log](https://developers.raisely.com/reference/patchexerciselog.md): Updates an existing exercise log #### For custom components: `RaiselyComponents.api.one('exercise-logs', '{uuid}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add exercise log](https://developers.raisely.com/reference/postexerciselogs.md): Creates a new **exercise log** #### For custom components: `RaiselyComponents.api.all('exercise-logs').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getinteractioncategories.md): Returns all of the **interaction categories** in the organisation #### For custom components: `RaiselyComponents.api.all('interaction_categories').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [remove interaction](https://developers.raisely.com/reference/deleteinteraction.md): Deletes an existing custom **interaction**. (Cannot delete system generated or read only interactions) #### For custom components: `RaiselyComponents.api.one('interactions', '{uuid}').delete(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get interaction](https://developers.raisely.com/reference/getinteraction.md): Retrieve a specific **interaction**. #### For custom components: `RaiselyComponents.api.one('interactions', '{uuid}').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getinteractions.md): Returns all **interactions** #### For custom components: `RaiselyComponents.api.all('interactions').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all interactions](https://developers.raisely.com/reference/getusersinteractions.md): Returns all **interactions** for a given user #### For custom components: `RaiselyComponents.api.one('users', '{uuid}').get('interactions', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update interaction](https://developers.raisely.com/reference/patchinteraction.md): Updates a specific **interaction**. Only interaction.details may be updated (Cannot delete system generated or read only interactions) #### For custom components: `RaiselyComponents.api.one('interactions', '{uuid}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [pin](https://developers.raisely.com/reference/patchinteractionspin.md): Pin / Unpin an **interaction** #### For custom components: `RaiselyComponents.api.one('interactions', '{uuid}').patch('pin', data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add interaction](https://developers.raisely.com/reference/postinteractions.md): Creates a new **interaction** #### For custom components: `RaiselyComponents.api.all('interactions').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add media](https://developers.raisely.com/reference/uploadcampaignmedia.md): Upload one or more files to the **media library** of your campaign. #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').one('media', '{folderUuid}').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get order](https://developers.raisely.com/reference/getorder.md): Returns a specific order #### For custom components: `RaiselyComponents.api.one('orders', '{uuid}').get('{uuid}', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getorders.md): Returns all orders in a campaign #### For custom components: `RaiselyComponents.api.all('orders').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [resend](https://developers.raisely.com/reference/postordersresend.md): Resend an order receipt #### For custom components: `RaiselyComponents.api.one('orders', '{uuid}').all('resend').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [remove post](https://developers.raisely.com/reference/deletepost.md): Delete the specified **post**. #### For custom components: `RaiselyComponents.api.one('posts', '{path}').delete(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get post](https://developers.raisely.com/reference/getpost.md): Retrieve a specific **post**. #### For custom components: `RaiselyComponents.api.one('posts', '{path}').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getposts.md): Returns a list of posts you've previously created. The posts will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.all('posts').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update post](https://developers.raisely.com/reference/patchpost.md): Update the specified **post**. #### For custom components: `RaiselyComponents.api.one('posts', '{path}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add post](https://developers.raisely.com/reference/postposts.md): Create a new **post** #### For custom components: `RaiselyComponents.api.all('posts').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all products](https://developers.raisely.com/reference/getcampaignsproducts.md): Returns all products in a campaign #### For custom components: `RaiselyComponents.api.one('campaigns', '{campaign}').get('products', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get product](https://developers.raisely.com/reference/getproduct.md): Returns a specific product #### For custom components: `RaiselyComponents.api.one('products', '{uuid}').get('{uuid}', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [remove profile](https://developers.raisely.com/reference/deleteprofile.md): Archives a profile. Archived profiles are hidden from the campaign. #### For custom components: `RaiselyComponents.api.one('profiles', '{path}').delete(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get profile](https://developers.raisely.com/reference/getprofile.md): Returns a specific profile #### For custom components: `RaiselyComponents.api.one('profiles', '{path}').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getprofiles.md): Returns all fundraising profiles in a campaign #### For custom components: `RaiselyComponents.api.all('profiles').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all donations](https://developers.raisely.com/reference/getprofilesdonations.md): Returns a list of donations you've previously created. The donations will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.one('profiles', '{path}').get('donations', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all members](https://developers.raisely.com/reference/getprofilesmembers.md): Returns list of all members of a team profile #### For custom components: `RaiselyComponents.api.one('profiles', '{path}').all('members').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all posts](https://developers.raisely.com/reference/getprofilesposts.md): Returns a list of posts you've previously created. The posts will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.one('profiles', '{path}').get('posts', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [profile url](https://developers.raisely.com/reference/getutilsprofileurl.md): Helper endpoint to verify if a profile url is taken for a given campaign, and make suggestions if the path queried is not available #### For custom components: `RaiselyComponents.api.all('utils').get('profile-url', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update profile](https://developers.raisely.com/reference/patchprofile.md): Updates a specific **profile** #### For custom components: `RaiselyComponents.api.one('profiles', '{path}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [join](https://developers.raisely.com/reference/patchprofilesjoin.md): Joins the specified profile to a a new parent #### For custom components: `RaiselyComponents.api.one('profiles', '{path}').patch('join', data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [leave](https://developers.raisely.com/reference/patchprofilesleave.md): Leaves the team profile (joins the campaign profile) #### For custom components: `RaiselyComponents.api.one('profiles', '{path}').patch('leave', data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add member](https://developers.raisely.com/reference/postprofilesmembers.md): Create a new **member** on the parent profile #### For custom components: `RaiselyComponents.api.one('profiles', '{path}').all('members').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get promo code](https://developers.raisely.com/reference/getpromocode.md): Returns a specific promo code #### For custom components: `RaiselyComponents.api.one('promo_codes', '{uuid}').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getpromocodes.md): Returns all promo codes in a campaign #### For custom components: `RaiselyComponents.api.all('promo_codes').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update promo code](https://developers.raisely.com/reference/patchpromocode.md): Updates a specific promo code #### For custom components: `RaiselyComponents.api.one('promo_codes', '{uuid}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add promo code](https://developers.raisely.com/reference/postpromocodes.md): Creates a new promo code #### For custom components: `RaiselyComponents.api.all('promo_codes').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getsegments.md): Returns a list of segments you've previously created. The segments will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.all('segments').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all users](https://developers.raisely.com/reference/getsegmentsusers.md): Get the users matched by the segment #### For custom components: `RaiselyComponents.api.one('segments', '{uuid}').get('users', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get subscription](https://developers.raisely.com/reference/getsubscription.md): Retrieve a specific **subscription**. #### For custom components: `RaiselyComponents.api.one('subscriptions', '{uuid}').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getsubscriptions.md): Returns a list of subscriptions you've previously created. The subscriptions will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.all('subscriptions').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all donations](https://developers.raisely.com/reference/getsubscriptionsdonations.md): Returns a list of donations you've previously created. The donations will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.one('subscriptions', '{uuid}').get('donations', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update subscription](https://developers.raisely.com/reference/patchsubscription.md): Update the subscription If you update the frequency or count for a donation, the nextPayment will be recalculated (unless you also update the nextPayment) based on the last donation or the date the subscription was created If nextPayment is set to a time in the past, it will be set to the current time #### For custom components: `RaiselyComponents.api.one('subscriptions', '{uuid}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add subscription](https://developers.raisely.com/reference/postsubscriptions.md): Creates a new subscription (otherwise known as a regular donation) in Raisely. External applications may use this endpoint to import regular donations created offline into Raisely, as long as you have tokenised card details in Stripe. To create a new subscription, you need to have a **customer** and **card** in Stripe, then set the `source` to `OFFLINE`. If you omit the `nextPayment` date, a payment will be taken immediately, otherwise it will be taken after the date specified. This endpoint must be authenticated. *Note: Raisely charges processing fees for imported subscriptions. Contact us for more information.* #### For custom components: `RaiselyComponents.api.all('subscriptions').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [remove record](https://developers.raisely.com/reference/deletetagsrecord.md): Removes an assigned tag from the specified record #### For custom components: `RaiselyComponents.api.one('tags', '{uuid}').one('records', '{recordUuid}').delete('{recordUuid}', data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get tag](https://developers.raisely.com/reference/gettag.md): Retrieve a specific **tag**. #### For custom components: `RaiselyComponents.api.one('tags', '{uuid}').get('{uuid}', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/gettags.md): Retrieve the list of tags. **NOTE** Unlike other endpoints, any tags flagged as private will not be present unless the request includes private=1 #### For custom components: `RaiselyComponents.api.all('tags').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all records](https://developers.raisely.com/reference/gettagsrecords.md): Get all Raisely records that are assigned the provided Tag #### For custom components: `RaiselyComponents.api.one('tags', '{uuid}').all('records').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add record](https://developers.raisely.com/reference/posttagsrecords.md): Assigns the provided tag to the specified records #### For custom components: `RaiselyComponents.api.one('tags', '{uuid}').all('records').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get user](https://developers.raisely.com/reference/getuser.md): Retrieve a specific **user**. #### For custom components: `RaiselyComponents.api.one('users', '{uuid}').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getusers.md): Returns a list of users you've previously created. The users will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.all('users').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all donations](https://developers.raisely.com/reference/getusersdonations.md): Returns a list of donations you've previously created. The donations will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.one('users', '{uuid}').get('donations', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all profiles](https://developers.raisely.com/reference/getusersprofiles.md): Returns all fundraising profiles owned by the provided user #### For custom components: `RaiselyComponents.api.one('users', '{uuid}').get('profiles', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [all subscriptions](https://developers.raisely.com/reference/getuserssubscriptions.md): Returns a list of subscriptions you've previously created. The subscriptions will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.one('users', '{uuid}').get('subscriptions', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update user](https://developers.raisely.com/reference/patchuser.md): Update the specified **user**. #### For custom components: `RaiselyComponents.api.one('users', '{uuid}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add user](https://developers.raisely.com/reference/postusers.md): Create a new **user** #### For custom components: `RaiselyComponents.api.all('users').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [upsert](https://developers.raisely.com/reference/postusersupsert.md): Upsert a user record, optionally tagging and creating an interaction. Useful for accepting form submissions. Requires a campaign UUID to be provided as a query parameter. #### For custom components: `RaiselyComponents.api.all('users').all('upsert').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getapidocs.md): Raisely OpenAPI specification #### For custom components: `RaiselyComponents.api.all('api-docs').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [remove webhook](https://developers.raisely.com/reference/deletewebhook.md): Delete a webhook #### For custom components: `RaiselyComponents.api.one('webhooks', '{uuid}').delete(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [get all](https://developers.raisely.com/reference/getwebhooks.md): Retrieve the list of webhooks configured for the campaign #### For custom components: `RaiselyComponents.api.all('webhooks').get(params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [update webhook](https://developers.raisely.com/reference/patchwebhook.md): Update the specified **webhook**. #### For custom components: `RaiselyComponents.api.one('webhooks', '{uuid}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper - [add webhook](https://developers.raisely.com/reference/postwebhooks.md): Add a new webhook to your Raisely account. By default, this webhook will trigger for events across all campaigns in your Raisely account. Specify a `campaignUuid` if you'd like to restrict it to one campaign. #### For custom components: `RaiselyComponents.api.all('webhooks').post(data = {}, params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper ## Changelog - [Welcome to Raisely](https://developers.raisely.com/changelog/welcome-to-raisely.md)