> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Raisely API reference

> API reference for the Raisely plugin in Corsair: every `raisely.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Campaigns

### get

`campaigns.get`

Fetch one campaign by uuid or path, including its totals, goal and public URL

**Risk:** `read`

```ts theme={null}
await corsair.raisely.api.campaigns.get({ campaign: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaign` | `string` | Yes | The campaign uuid or path, as returned by `campaigns.list`. |
| `private` | `boolean` | No | Return the full record. Only meaningful with a token that can see private fields. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaign` | `object` | Yes | — |

> [accordion] campaign full type
>
> ```ts theme={null}
> {
>   uuid?: string | null,
>   name?: string | null,
>   path?: string | null,
>   url?: string | null,
>   mode?: string | null,
>   status?: string | null,
>   currency?: string | null,
>   goal?: number | null,
>   total?: number | null,
>   totalPercent?: number | null,
>   grandTotal?: number | null,
>   version?: string | null,
>   theme?: string | null,
>   primaryDomain?: string | null,
>   organisationUuid?: string | null,
>   campaignEndsAt?: string | null,
>   createdAt?: string | null,
>   deletedAt?: string | null,
>   defaultDesignation?: string | null,
>   isTaxDeductible?: boolean | null,
>   enablePartialTaxReceipting?: boolean | null,
>   allowExperiments?: boolean | null,
>   showRaiselyCheckbox?: boolean | null,
>   publicKey?: string | null,
>   profile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   urls?: string[] | null,
>   config?: Record<string, any> | null,
>   public?: Record<string, any> | null,
>   private?: Record<string, any> | null
> }
> ```

***

### list

`campaigns.list`

List the organisation’s campaigns with path, mode and status filters plus offset paging

**Risk:** `read`

```ts theme={null}
await corsair.raisely.api.campaigns.list({ status: 'ACTIVE', limit: 100, sort: 'createdAt', order: 'desc' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | Records per page. Raisely applies its own default when omitted. |
| `offset` | `number` | No | Records to skip. Pass the `next_offset` from the previous page rather than computing it. |
| `q` | `string` | No | A search phrase. |
| `sort` | `string` | No | The attribute to sort on, used with `order`. |
| `order` | `asc \| desc` | No | The sort direction; only applied when `sort` is also set. |
| `private` | `boolean` | No | Return the full record. Only meaningful with a token that can see private fields. |
| `path` | `string` | No | Only the campaign with this path. |
| `mode` | `string` | No | The campaign mode. |
| `status` | `string` | No | The campaign status. |
| `prune_config` | `boolean` | No | Drop `config` from each record to shrink the response. |
| `include_tags` | `boolean` | No | — |

`order` is only sent when `sort` is also set, because Raisely ignores it alone.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaigns` | `object[]` | Yes | — |
| `pagination` | `object \| null` | No | — |
| `next_offset` | `number \| null` | Yes | Pass as `offset` to read the next page; null on the last. |
| `total` | `number \| null` | Yes | — |

> [accordion] campaigns full type
>
> ```ts theme={null}
> {
>   uuid?: string | null,
>   name?: string | null,
>   path?: string | null,
>   url?: string | null,
>   mode?: string | null,
>   status?: string | null,
>   currency?: string | null,
>   goal?: number | null,
>   total?: number | null,
>   totalPercent?: number | null,
>   grandTotal?: number | null,
>   version?: string | null,
>   theme?: string | null,
>   primaryDomain?: string | null,
>   organisationUuid?: string | null,
>   campaignEndsAt?: string | null,
>   createdAt?: string | null,
>   deletedAt?: string | null,
>   defaultDesignation?: string | null,
>   isTaxDeductible?: boolean | null,
>   enablePartialTaxReceipting?: boolean | null,
>   allowExperiments?: boolean | null,
>   showRaiselyCheckbox?: boolean | null,
>   publicKey?: string | null,
>   profile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   urls?: string[] | null,
>   config?: Record<string, any> | null,
>   public?: Record<string, any> | null,
>   private?: Record<string, any> | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   total?: number | null,
>   pages?: number | null,
>   offset?: number | null,
>   limit?: number | null,
>   prevUrl?: string | boolean | null,
>   nextUrl?: string | boolean | null
> } | null
> ```

***

## Designations

### list

`designations.list`

List the designations a donation can be attributed to, optionally for one campaign

**Risk:** `read`

```ts theme={null}
await corsair.raisely.api.designations.list({ campaign: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa', status: 'ACTIVE' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | Records per page. Raisely applies its own default when omitted. |
| `offset` | `number` | No | Records to skip. Pass the `next_offset` from the previous page rather than computing it. |
| `q` | `string` | No | A search phrase. |
| `sort` | `string` | No | The attribute to sort on, used with `order`. |
| `order` | `asc \| desc` | No | The sort direction; only applied when `sort` is also set. |
| `private` | `boolean` | No | Return the full record. Only meaningful with a token that can see private fields. |
| `campaign` | `string` | No | Only the designations of this campaign. |
| `status` | `string` | No | — |

A designation is what a donation is attributed to; `publicName` is the label shown to donors.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `designations` | `object[]` | Yes | — |
| `pagination` | `object \| null` | No | — |
| `next_offset` | `number \| null` | Yes | Pass as `offset` to read the next page; null on the last. |
| `total` | `number \| null` | Yes | — |

> [accordion] designations full type
>
> ```ts theme={null}
> {
>   uuid?: string | null,
>   name?: string | null,
>   publicName?: string | null,
>   externalId?: string | null,
>   status?: string | null,
>   organisationId?: number | null,
>   createdAt?: string | null,
>   updatedAt?: string | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   total?: number | null,
>   pages?: number | null,
>   offset?: number | null,
>   limit?: number | null,
>   prevUrl?: string | boolean | null,
>   nextUrl?: string | boolean | null
> } | null
> ```

***

## Donations

### create

`donations.create`

Record a donation already paid elsewhere, with the donor details and the gateway it came through; it charges no one and sends no receipt

**Risk:** `write`

```ts theme={null}
await corsair.raisely.api.donations.create({ amount: 2500, currency: 'USD', email: 'jordan@example.com', method: 'CREDIT_CARD', type: 'OFFLINE', campaign_uuid: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `amount` | `number` | Yes | The donation total in the smallest currency unit, so 2500 is \$25.00. |
| `currency` | `string` | Yes | A three-letter currency code. |
| `email` | `string` | Yes | The donor email. |
| `method` | `string` | Yes | The payment gateway, such as `CREDIT_CARD`, `PAYPAL` or `APPLE_PAY`. |
| `type` | `ONLINE \| OFFLINE` | Yes | Raisely stores every donation recorded on this route as `OFFLINE`, whatever is sent, so pass `OFFLINE`. The route only records a payment made elsewhere and charges nothing. |
| `campaign_uuid` | `string` | No | The campaign the donation belongs to. |
| `profile_uuid` | `string` | No | The fundraising profile the donation is credited to. |
| `firstName` | `string` | No | — |
| `lastName` | `string` | No | — |
| `fullName` | `string` | No | — |
| `preferredName` | `string` | No | — |
| `message` | `string` | No | — |
| `anonymous` | `boolean` | No | — |
| `date` | `string` | No | An ISO 8601 timestamp. |
| `country` | `string` | No | — |
| `postcode` | `string` | No | — |
| `address1` | `string` | No | — |
| `address2` | `string` | No | — |
| `phoneNumber` | `string` | No | — |
| `mode` | `LIVE \| TEST` | No | — |
| `designation` | `string` | No | The designation uuid to attribute the donation to. |
| `public` | `Record<string, string \| number \| boolean \| Record<string, string \| number \| boolean \| null> \| (string \| number \| boolean)[] \| null> \| null` | No | — |
| `private` | `Record<string, string \| number \| boolean \| Record<string, string \| number \| boolean \| null> \| (string \| number \| boolean)[] \| null> \| null` | No | — |

The record is sent under `data`; amounts are integers in the smallest currency unit.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `donation` | `object` | Yes | — |

> [accordion] donation full type
>
> ```ts theme={null}
> {
>   uuid?: string | null,
>   id?: number | null,
>   amount?: number | null,
>   amountRefunded?: number | null,
>   currency?: string | null,
>   currencySymbol?: string | null,
>   campaignCurrency?: string | null,
>   campaignAmount?: number | null,
>   campaignUuid?: string | null,
>   displayTotal?: number | null,
>   donationTotal?: number | null,
>   organisationUuid?: string | null,
>   profileUuid?: string | null,
>   profile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   date?: string | null,
>   createdAt?: string | null,
>   email?: string | null,
>   firstName?: string | null,
>   lastName?: string | null,
>   fullName?: string | null,
>   preferredName?: string | null,
>   message?: string | null,
>   anonymous?: boolean | null,
>   method?: string | null,
>   methodType?: string | null,
>   mode?: string | null,
>   status?: string | null,
>   processing?: string | null,
>   declineCode?: string | null,
>   isFraud?: boolean | null,
>   isSuspicious?: boolean | null,
>   fee?: number | null,
>   feeOptIn?: boolean | null,
>   feeModel?: string | null,
>   gst?: number | null,
>   includesGiftAid?: boolean | null,
>   giftAidText?: string | null,
>   country?: string | null,
>   postcode?: string | null,
>   phoneNumber?: string | null,
>   designationUuid?: string | null,
>   designation?: {
>     uuid?: string | null,
>     name?: string | null,
>     publicName?: string | null
>   } | null,
>   allocations?: {
>     amount?: number | null,
>     amountRefunded?: number | null,
>     campaignAmount?: number | null,
>     campaignAmountRefunded?: number | null,
>     designationUuid?: string | null,
>     designation?: {
>       uuid?: string | null,
>       name?: string | null,
>       publicName?: string | null
>     } | null
>   }[] | null,
>   items?: {
>     amount?: number | null,
>     amountRefunded?: number | null,
>     attendance?: string | null,
>     quantity?: number | null,
>     description?: string | null,
>     name?: string | null
>   }[] | null,
>   itemTypes?: string[] | null,
>   context?: Record<string, string> | null,
>   public?: Record<string, any> | null,
>   private?: Record<string, any> | null
> }
> ```

***

### get

`donations.get`

Fetch one donation by uuid with its amount, gateway state and designation

**Risk:** `read`

```ts theme={null}
await corsair.raisely.api.donations.get({ donation_uuid: 'bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `donation_uuid` | `string` | Yes | The donation uuid. |
| `private` | `boolean` | No | Return the full record. Only meaningful with a token that can see private fields. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `donation` | `object` | Yes | — |

> [accordion] donation full type
>
> ```ts theme={null}
> {
>   uuid?: string | null,
>   id?: number | null,
>   amount?: number | null,
>   amountRefunded?: number | null,
>   currency?: string | null,
>   currencySymbol?: string | null,
>   campaignCurrency?: string | null,
>   campaignAmount?: number | null,
>   campaignUuid?: string | null,
>   displayTotal?: number | null,
>   donationTotal?: number | null,
>   organisationUuid?: string | null,
>   profileUuid?: string | null,
>   profile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   date?: string | null,
>   createdAt?: string | null,
>   email?: string | null,
>   firstName?: string | null,
>   lastName?: string | null,
>   fullName?: string | null,
>   preferredName?: string | null,
>   message?: string | null,
>   anonymous?: boolean | null,
>   method?: string | null,
>   methodType?: string | null,
>   mode?: string | null,
>   status?: string | null,
>   processing?: string | null,
>   declineCode?: string | null,
>   isFraud?: boolean | null,
>   isSuspicious?: boolean | null,
>   fee?: number | null,
>   feeOptIn?: boolean | null,
>   feeModel?: string | null,
>   gst?: number | null,
>   includesGiftAid?: boolean | null,
>   giftAidText?: string | null,
>   country?: string | null,
>   postcode?: string | null,
>   phoneNumber?: string | null,
>   designationUuid?: string | null,
>   designation?: {
>     uuid?: string | null,
>     name?: string | null,
>     publicName?: string | null
>   } | null,
>   allocations?: {
>     amount?: number | null,
>     amountRefunded?: number | null,
>     campaignAmount?: number | null,
>     campaignAmountRefunded?: number | null,
>     designationUuid?: string | null,
>     designation?: {
>       uuid?: string | null,
>       name?: string | null,
>       publicName?: string | null
>     } | null
>   }[] | null,
>   items?: {
>     amount?: number | null,
>     amountRefunded?: number | null,
>     attendance?: string | null,
>     quantity?: number | null,
>     description?: string | null,
>     name?: string | null
>   }[] | null,
>   itemTypes?: string[] | null,
>   context?: Record<string, string> | null,
>   public?: Record<string, any> | null,
>   private?: Record<string, any> | null
> }
> ```

***

### list

`donations.list`

List donations with campaign, profile, status, mode and currency filters plus offset paging

**Risk:** `read`

```ts theme={null}
await corsair.raisely.api.donations.list({ campaign: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa', mode: 'LIVE', limit: 100 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | Records per page. Raisely applies its own default when omitted. |
| `offset` | `number` | No | Records to skip. Pass the `next_offset` from the previous page rather than computing it. |
| `q` | `string` | No | A search phrase. |
| `sort` | `string` | No | The attribute to sort on, used with `order`. |
| `order` | `asc \| desc` | No | The sort direction; only applied when `sort` is also set. |
| `private` | `boolean` | No | Return the full record. Only meaningful with a token that can see private fields. |
| `campaign` | `string` | No | Only this campaign uuid. |
| `profile` | `string` | No | Only this profile uuid. |
| `user` | `string` | No | Only this user uuid. |
| `organisation` | `string` | No | Only this organisation uuid. |
| `designation` | `string` | No | Only this designation uuid. |
| `subscription` | `string` | No | — |
| `status` | `string` | No | — |
| `mode` | `string` | No | `LIVE` or `TEST`. |
| `currency` | `string` | No | — |
| `type` | `string` | No | The donation type. |
| `is_suspicious` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `donations` | `object[]` | Yes | — |
| `pagination` | `object \| null` | No | — |
| `next_offset` | `number \| null` | Yes | Pass as `offset` to read the next page; null on the last. |
| `total` | `number \| null` | Yes | — |

> [accordion] donations full type
>
> ```ts theme={null}
> {
>   uuid?: string | null,
>   id?: number | null,
>   amount?: number | null,
>   amountRefunded?: number | null,
>   currency?: string | null,
>   currencySymbol?: string | null,
>   campaignCurrency?: string | null,
>   campaignAmount?: number | null,
>   campaignUuid?: string | null,
>   displayTotal?: number | null,
>   donationTotal?: number | null,
>   organisationUuid?: string | null,
>   profileUuid?: string | null,
>   profile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   date?: string | null,
>   createdAt?: string | null,
>   email?: string | null,
>   firstName?: string | null,
>   lastName?: string | null,
>   fullName?: string | null,
>   preferredName?: string | null,
>   message?: string | null,
>   anonymous?: boolean | null,
>   method?: string | null,
>   methodType?: string | null,
>   mode?: string | null,
>   status?: string | null,
>   processing?: string | null,
>   declineCode?: string | null,
>   isFraud?: boolean | null,
>   isSuspicious?: boolean | null,
>   fee?: number | null,
>   feeOptIn?: boolean | null,
>   feeModel?: string | null,
>   gst?: number | null,
>   includesGiftAid?: boolean | null,
>   giftAidText?: string | null,
>   country?: string | null,
>   postcode?: string | null,
>   phoneNumber?: string | null,
>   designationUuid?: string | null,
>   designation?: {
>     uuid?: string | null,
>     name?: string | null,
>     publicName?: string | null
>   } | null,
>   allocations?: {
>     amount?: number | null,
>     amountRefunded?: number | null,
>     campaignAmount?: number | null,
>     campaignAmountRefunded?: number | null,
>     designationUuid?: string | null,
>     designation?: {
>       uuid?: string | null,
>       name?: string | null,
>       publicName?: string | null
>     } | null
>   }[] | null,
>   items?: {
>     amount?: number | null,
>     amountRefunded?: number | null,
>     attendance?: string | null,
>     quantity?: number | null,
>     description?: string | null,
>     name?: string | null
>   }[] | null,
>   itemTypes?: string[] | null,
>   context?: Record<string, string> | null,
>   public?: Record<string, any> | null,
>   private?: Record<string, any> | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   total?: number | null,
>   pages?: number | null,
>   offset?: number | null,
>   limit?: number | null,
>   prevUrl?: string | boolean | null,
>   nextUrl?: string | boolean | null
> } | null
> ```

***

## Profiles

### get

`profiles.get`

Fetch one fundraising profile by its path, including its totals and goal

**Risk:** `read`

```ts theme={null}
await corsair.raisely.api.profiles.get({ profile_path: 'jordan-lee' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `profile_path` | `string` | Yes | The profile uuid or path, as returned by `profiles.list`. |
| `private` | `boolean` | No | Return the full record. Only meaningful with a token that can see private fields. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `profile` | `object` | Yes | — |

> [accordion] profile full type
>
> ```ts theme={null}
> {
>   uuid?: string | null,
>   name?: string | null,
>   path?: string | null,
>   photoUrl?: string | null,
>   type?: string | null,
>   status?: string | null,
>   description?: string | null,
>   currency?: string | null,
>   goal?: number | null,
>   total?: number | null,
>   grandTotal?: number | null,
>   campaignTotal?: number | null,
>   campaignDisplayTotal?: number | null,
>   activityTotal?: number | null,
>   activityTotalPercent?: number | null,
>   donationCount?: number | null,
>   donationRecordCount?: number | null,
>   uniqueDonors?: number | null,
>   selfDonationTotal?: number | null,
>   nonSelfDonationTotal?: number | null,
>   exerciseTotal?: number | null,
>   exerciseTotalTime?: number | null,
>   exerciseGoal?: number | null,
>   exerciseGoalTime?: number | null,
>   isCampaignProfile?: boolean | null,
>   paid?: boolean | null,
>   shared?: boolean | null,
>   pronouns?: string | null,
>   fundraiserTheme?: string | null,
>   facebookFundraiserId?: string | null,
>   subscriptionCount?: number | null,
>   teamProfileCount?: number | null,
>   organisationProfileCount?: number | null,
>   individualProfileCount?: number | null,
>   campaignUuid?: string | null,
>   userUuid?: string | null,
>   parentUuid?: string | null,
>   createdAt?: string | null,
>   updatedAt?: string | null,
>   user?: {
>     uuid?: string | null,
>     email?: string | null,
>     firstName?: string | null,
>     lastName?: string | null,
>     fullName?: string | null,
>     photoUrl?: string | null
>   } | null,
>   parent?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   teamProfile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   organisationProfile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   tags?: string[] | null,
>   public?: Record<string, any> | null,
>   private?: Record<string, any> | null
> }
> ```

***

### list

`profiles.list`

List the fundraising profiles in a campaign with their totals, goals and donation counts

**Risk:** `read`

```ts theme={null}
await corsair.raisely.api.profiles.list({ campaign: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa', limit: 50 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | Records per page. Raisely applies its own default when omitted. |
| `offset` | `number` | No | Records to skip. Pass the `next_offset` from the previous page rather than computing it. |
| `q` | `string` | No | A search phrase. |
| `sort` | `string` | No | The attribute to sort on, used with `order`. |
| `order` | `asc \| desc` | No | The sort direction; only applied when `sort` is also set. |
| `private` | `boolean` | No | Return the full record. Only meaningful with a token that can see private fields. |
| `campaign` | `string` | Yes | The campaign uuid or path. Raisely requires this on `/profiles`. |
| `rank` | `boolean` | No | Include the rank fields. |
| `rank_donors` | `boolean` | No | — |
| `rank_activity_total` | `boolean` | No | — |
| `rank_activity_time` | `boolean` | No | — |

Raisely requires `campaign` on this route, so the schema makes it mandatory.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `profiles` | `object[]` | Yes | — |
| `pagination` | `object \| null` | No | — |
| `next_offset` | `number \| null` | Yes | Pass as `offset` to read the next page; null on the last. |
| `total` | `number \| null` | Yes | — |

> [accordion] profiles full type
>
> ```ts theme={null}
> {
>   uuid?: string | null,
>   name?: string | null,
>   path?: string | null,
>   photoUrl?: string | null,
>   type?: string | null,
>   status?: string | null,
>   description?: string | null,
>   currency?: string | null,
>   goal?: number | null,
>   total?: number | null,
>   grandTotal?: number | null,
>   campaignTotal?: number | null,
>   campaignDisplayTotal?: number | null,
>   activityTotal?: number | null,
>   activityTotalPercent?: number | null,
>   donationCount?: number | null,
>   donationRecordCount?: number | null,
>   uniqueDonors?: number | null,
>   selfDonationTotal?: number | null,
>   nonSelfDonationTotal?: number | null,
>   exerciseTotal?: number | null,
>   exerciseTotalTime?: number | null,
>   exerciseGoal?: number | null,
>   exerciseGoalTime?: number | null,
>   isCampaignProfile?: boolean | null,
>   paid?: boolean | null,
>   shared?: boolean | null,
>   pronouns?: string | null,
>   fundraiserTheme?: string | null,
>   facebookFundraiserId?: string | null,
>   subscriptionCount?: number | null,
>   teamProfileCount?: number | null,
>   organisationProfileCount?: number | null,
>   individualProfileCount?: number | null,
>   campaignUuid?: string | null,
>   userUuid?: string | null,
>   parentUuid?: string | null,
>   createdAt?: string | null,
>   updatedAt?: string | null,
>   user?: {
>     uuid?: string | null,
>     email?: string | null,
>     firstName?: string | null,
>     lastName?: string | null,
>     fullName?: string | null,
>     photoUrl?: string | null
>   } | null,
>   parent?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   teamProfile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   organisationProfile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   tags?: string[] | null,
>   public?: Record<string, any> | null,
>   private?: Record<string, any> | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   total?: number | null,
>   pages?: number | null,
>   offset?: number | null,
>   limit?: number | null,
>   prevUrl?: string | boolean | null,
>   nextUrl?: string | boolean | null
> } | null
> ```

***

### update

`profiles.update`

Update a fundraising profile: its name, description, goal, photo or custom values

**Risk:** `write`

```ts theme={null}
await corsair.raisely.api.profiles.update({ profile_path: 'jordan-lee', goal: 6000 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `profile_path` | `string` | Yes | — |
| `name` | `string` | No | — |
| `description` | `string \| null` | No | The profile description; null clears it. |
| `goal` | `number` | No | — |
| `photoUrl` | `string \| null` | No | The profile photo URL; null clears it. |
| `pronouns` | `string \| null` | No | The fundraiser pronouns; null clears them. |
| `shared` | `boolean` | No | — |
| `status` | `string` | No | — |
| `public` | `Record<string, string \| number \| boolean \| Record<string, string \| number \| boolean \| null> \| (string \| number \| boolean)[] \| null> \| null` | No | — |
| `private` | `Record<string, string \| number \| boolean \| Record<string, string \| number \| boolean \| null> \| (string \| number \| boolean)[] \| null> \| null` | No | — |

The body is sent under `data`, and the path identifies the record rather than the body.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `profile` | `object` | Yes | — |

> [accordion] profile full type
>
> ```ts theme={null}
> {
>   uuid?: string | null,
>   name?: string | null,
>   path?: string | null,
>   photoUrl?: string | null,
>   type?: string | null,
>   status?: string | null,
>   description?: string | null,
>   currency?: string | null,
>   goal?: number | null,
>   total?: number | null,
>   grandTotal?: number | null,
>   campaignTotal?: number | null,
>   campaignDisplayTotal?: number | null,
>   activityTotal?: number | null,
>   activityTotalPercent?: number | null,
>   donationCount?: number | null,
>   donationRecordCount?: number | null,
>   uniqueDonors?: number | null,
>   selfDonationTotal?: number | null,
>   nonSelfDonationTotal?: number | null,
>   exerciseTotal?: number | null,
>   exerciseTotalTime?: number | null,
>   exerciseGoal?: number | null,
>   exerciseGoalTime?: number | null,
>   isCampaignProfile?: boolean | null,
>   paid?: boolean | null,
>   shared?: boolean | null,
>   pronouns?: string | null,
>   fundraiserTheme?: string | null,
>   facebookFundraiserId?: string | null,
>   subscriptionCount?: number | null,
>   teamProfileCount?: number | null,
>   organisationProfileCount?: number | null,
>   individualProfileCount?: number | null,
>   campaignUuid?: string | null,
>   userUuid?: string | null,
>   parentUuid?: string | null,
>   createdAt?: string | null,
>   updatedAt?: string | null,
>   user?: {
>     uuid?: string | null,
>     email?: string | null,
>     firstName?: string | null,
>     lastName?: string | null,
>     fullName?: string | null,
>     photoUrl?: string | null
>   } | null,
>   parent?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   teamProfile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   organisationProfile?: {
>     uuid?: string | null,
>     name?: string | null,
>     path?: string | null,
>     photoUrl?: string | null
>   } | null,
>   tags?: string[] | null,
>   public?: Record<string, any> | null,
>   private?: Record<string, any> | null
> }
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.