Raisely

Deletes the campaign. DELETE /v3/campaigns/{campaign}

Remove a media item from the campaign media library by UUID. The underlying file is not deleted. DELETE /v3/campaigns/{campaign}/media/{uuid}

Delete a donation record. Only possible for OFFLINE donations. DELETE /v3/donations/{uuid}

Delete the specified **exercise log**. DELETE /v3/exercise-logs/{uuid}

Deletes an existing custom **interaction**. (Cannot delete system generated or read only interactions). DELETE /v3/interactions/{uuid}

Remove a media item from the organisation media library by UUID. The underlying file is not deleted. DELETE /v3/organisations/{organisation}/media/{uuid}

Delete the specified **post**. DELETE /v3/posts/{path}

Archives a profile. Archived profiles are hidden from the campaign. DELETE /v3/profiles/{path}

Removes an assigned tag from the specified record. DELETE /v3/tags/{uuid}/records/{recordUuid}

Delete a webhook. DELETE /v3/webhooks/{uuid}

Raisely OpenAPI specification. GET /v3/api-docs

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. GET /v3/authenticate

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. GET /v3/campaigns

Retrieve a specific **campaign**. GET /v3/campaigns/{campaign}

Returns designations associated with a campaign, ordered by sortOrder. GET /v3/campaigns/{campaign}/designations

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. GET /v3/campaigns/{campaign}/donations

Returns all images in the campaign media library. GET /v3/campaigns/{campaign}/media

Returns all products in a campaign. GET /v3/campaigns/{campaign}/products

Return the campaign profile <br><br> 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. GET /v3/campaigns/{campaign}/profile

Returns all fundraising profiles in a campaign. GET /v3/campaigns/{campaign}/profiles

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. GET /v3/campaigns/{campaign}/subscriptions

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. GET /v3/designations

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. GET /v3/donations

Retrieve a specific **donation**. GET /v3/donations/{uuid}

Returns a list of the receipts attached to this donation. GET /v3/donations/{uuid}/receipts

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. GET /v3/exercise-logs

Retrieve a specific **exercise log**. GET /v3/exercise-logs/{uuid}

Returns all of the **interaction categories** in the organisation. GET /v3/interaction_categories

Returns all **interactions**. GET /v3/interactions

Retrieve a specific **interaction**. GET /v3/interactions/{uuid}

Returns all orders in a campaign. GET /v3/orders

Returns a specific order. GET /v3/orders/{uuid}

Returns all images in the organisation media library. GET /v3/organisations/{organisation}/media

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. GET /v3/posts

Retrieve a specific **post**. GET /v3/posts/{path}

Returns a specific product. GET /v3/products/{uuid}

Returns all fundraising profiles in a campaign. GET /v3/profiles

Returns a specific profile. GET /v3/profiles/{path}

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. GET /v3/profiles/{path}/donations

Returns list of all members of a team profile. GET /v3/profiles/{path}/members

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. GET /v3/profiles/{path}/posts

Returns all promo codes in a campaign. GET /v3/promo_codes

Returns a specific promo code. GET /v3/promo_codes/{uuid}

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. GET /v3/segments

Get the users matched by the segment. GET /v3/segments/{uuid}/users

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. GET /v3/subscriptions

Retrieve a specific **subscription**. GET /v3/subscriptions/{uuid}

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. GET /v3/subscriptions/{uuid}/donations

Retrieve the list of tags. **NOTE** Unlike other endpoints, any tags flagged as private will not be present unless the request includes private=1. GET /v3/tags

Retrieve a specific **tag**. GET /v3/tags/{uuid}

Get all Raisely records that are assigned the provided Tag. GET /v3/tags/{uuid}/records

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. GET /v3/users

Retrieve a specific **user**. GET /v3/users/{uuid}

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. GET /v3/users/{uuid}/donations

Returns all **interactions** for a given user. GET /v3/users/{uuid}/interactions

Returns all fundraising profiles owned by the provided user. GET /v3/users/{uuid}/profiles

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. GET /v3/users/{uuid}/subscriptions

Helper endpoint to verify if a profile url is taken for a given campaign, and make suggestions if the path queried is not available. GET /v3/utils/profile-url

Retrieve the list of webhooks configured for the campaign. GET /v3/webhooks

Updates the campaign with the new data. PATCH /v3/campaigns/{campaign}

Update a subkey of the config. This will overwrite the entire value of the key. PATCH /v3/campaigns/{campaign}/config/{attribute}

Update the specified donation. PATCH /v3/donations/{uuid}

Move a donation to a different profile (the profile may be located in a different campaign). PATCH /v3/donations/{uuid}/move

Updates an existing exercise log. PATCH /v3/exercise-logs/{uuid}

Updates a specific **interaction**. Only interaction.details may be updated (Cannot delete system generated or read only interactions). PATCH /v3/interactions/{uuid}

Pin / Unpin an **interaction**. PATCH /v3/interactions/{uuid}/pin

Update the specified **post**. PATCH /v3/posts/{path}

Updates a specific **profile**. PATCH /v3/profiles/{path}

Joins the specified profile to a a new parent. PATCH /v3/profiles/{path}/join

Leaves the team profile (joins the campaign profile). PATCH /v3/profiles/{path}/leave

Updates a specific promo code. PATCH /v3/promo_codes/{uuid}

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. PATCH /v3/subscriptions/{uuid}

Update the specified **user**. PATCH /v3/users/{uuid}

Update the specified **webhook**. PATCH /v3/webhooks/{uuid}

Create a new or cloned campaign. POST /v3/campaigns

Add an image to the campaign media library. Accepts either a `multipart/form-data` upload or an `application/json` body with a `url` to fetch server-side. Accepted formats: PNG, JPG, GIF, WebP, SVG (max 20 MB). POST /v3/campaigns/{campaign}/media

Restores the campaign. POST /v3/campaigns/{campaign}/restore

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. POST /v3/donations

Match a donation using the specified matched giving configuration. POST /v3/donations/{uuid}/match

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. POST /v3/donations/{uuid}/resend

Creates a new **exercise log**. POST /v3/exercise-logs

Creates a new **interaction**. POST /v3/interactions

Resend an order receipt. POST /v3/orders/{uuid}/resend

Add an image to the organisation media library. Accepts either a `multipart/form-data` upload or an `application/json` body with a `url` to fetch server-side. Accepted formats: PNG, JPG, GIF, WebP, SVG (max 20 MB). POST /v3/organisations/{organisation}/media

Create a new **post**. **Specifying the post author (explicit-user rollout):** When the explicit-user rollout is enabled for the organisation, data.userUuid is an optional author override. POST /v3/posts

Create a new **member** on the parent profile. **Owner of the member profile:** data.userUuid is optional. POST /v3/profiles/{path}/members

Creates a new promo code. POST /v3/promo_codes

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. POST /v3/subscriptions

Assigns the provided tag to the specified records. POST /v3/tags/{uuid}/records

Create a new **user**. POST /v3/users

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. POST /v3/users/upsert

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. POST /v3/webhooks