--- title: "update profile" method: PATCH path: "/profiles/{path}" tags: ["Profiles"] --- # update profile `PATCH /profiles/{path}` 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 ## Path parameters - `path` string, required ## Query parameters - `campaign` string - `private` boolean - `partial` boolean ## Headers - `Authorization` string ## Request body - object - `data` UpdateProfile - `currency` string — 3 letter currency code Examples: `AUD`, `USD` - `description` string — Public description of the fundraiser profile Example: `I believe in a better world` - `exerciseGoal` integer — The exercise distance goal for the profile, in metres Example: `12345` - `exerciseGoalTime` integer — The time spent exercising goal for the profile, in minutes Example: `12345` - `fundraiserTheme` string — Path of the DIY fundraiser theme selected by the fundraiser Examples: `birthday`, `bake-sale` - `goal` integer — Fundraising target (in cents) Example: `100050` - `name` string — The name of the profile Example: `Bob D.` - `path` string — The path of this record (for alternative lookup) Example: `bobd` - `photoUrl` string — URL of the profile photo Example: `https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png` - `private` object — Private values for this record Example: `{ "fieldA": "one", "fieldB": "yes" }` - `pronouns` string — Pronouns of the profile - `public` object — Public values for this record Example: `{ "fieldA": "one", "fieldB": "yes" }` - `type` 'INDIVIDUAL' | 'GROUP' | 'ORGANISATION' — INDIVIDUAL, GROUP or ORGANISATION Examples: `INDIVIDUAL`, `GROUP`, `ORGANISATION` - `overwriteCustomFields` boolean — If passed, replace the existing `public` and `private` values on the record with the values provided with this payload ## Response `200` The updated Profile record - object - `data` UpdateResultProfile - `activityTotal` integer — The total contribution of this profile towards its activity goal - `activityTotalPercent` integer — The percentage of the total activity measure compared to the profile goal (out of 100) - `badges` NestedBadge[] — A collection of badges earned by this profile - `condition` string — `public` How to match the rules - `config` object — `public` Custom configuration for the badge - `description` string — `public` Description of the badge - `hidden` boolean — `public` This badge will not be displayed until it is earned - `icon` string — `public` Icon for the badge - `imageUrl` string — `public` Image to use for the badge - `incompleteImageUrl` string — `public` Alternate image for an incomplete badge - `name` string — `public` Name of the badge - `path` string — `public` The path of this record (for alternative lookup) - `private` object — `public` Private values for this record - `profileCount` integer — `public` The number of profiles that have been awarded this badge - `public` object — `public` Public values for this record - `rules` Rule[] — A set of rules applying to this record - `comparison` 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'absent' | 'present' — * `eq` - Equal `==` * `neq` - Not equal `!=` * `gt` - Greater than `>` * `gte` - Greater than or equals `>=` * `lt` - Less than `<` * `lte` - Less than or equals `<=` * `absent` - Is unset `!` * `present` - Is set `!!` - `property` string — The property path on the record that this rule will apply to - `value` union — The value that this condition will apply itself to - string - number - `sortOrder` integer — `public` Ordering of the badge relative to others in the campaign - `uuid` string — `public` Unique identifier for the record - `campaignDisplayTotal` integer — The total amount raised by a profile (in the currency of the campaign) - `campaignTotal` integer — The total amount contributed by a profile to the campaign total (in the currency of the campaign) - `campaignUuid` string — Unique identifier for the record - `createdAt` string — Date the record was created - `currency` string — 3 letter currency code - `description` string — Public description of the fundraiser profile - `donationCount` integer — Total donations made to this profile and it's children. (excluded matched gifts) - `donationRecordCount` integer — Every donation record on this profile regardless of status or mode (same scope as permanent-delete validation, broader than donationCount). - `exerciseGoal` integer — The exercise distance goal for the profile, in metres - `exerciseGoalTime` integer — The time spent exercising goal for the profile, in minutes - `exerciseTotal` integer — The total distance of exercise completed, in metres - `exerciseTotalTime` integer — The total amount of time exercising, in minutes - `facebookFundraiserId` string — Facebook Fundraiser ID linked to the profile - `fundraiserTheme` string — Path of the DIY fundraiser theme selected by the fundraiser - `goal` integer — Fundraising target (in cents) - `grandTotal` integer — The total amount raised by a profile (including registration fees) - `individualProfileCount` integer — Number of individual profiles that have joined this profile (or it's descendants) - `isCampaignProfile` boolean — Shows true if this profile is the campaign profile - `name` string — The name of the profile - `nonSelfDonationTotal` integer — The total amount raised by a profile excluding self-donations (in the currency of the campaign) - `organisationProfileCount` integer — Number of team profiles that have joined this profile (or it's descendants) - `paid` boolean — Flagged as true if this profile was used as part of a paid registration - `path` string — The path of this record (for alternative lookup) - `photoUrl` string — URL of the profile photo - `private` object — Private values for this record - `pronouns` string — Pronouns of the profile - `public` object — Public values for this record - `selfDonationTotal` integer — The total amount raised by self-donations for an individual profile (in the currency of the campaign) - `shared` boolean — Flag that determines if a profile has been shared by its owner - `status` 'ACTIVE' | 'DELETED' | 'PURGED' — ACTIVE, DELETED, or PURGED - `subscriptionCount` integer — Subscriptions associated with this profile (same scope as permanent-delete validation). - `teamProfileCount` integer — Number of team profiles that have joined this profile (or it's descendants) - `total` integer — The total amount raised by a profile (in the currency of the profile) - `type` 'INDIVIDUAL' | 'GROUP' | 'ORGANISATION' — INDIVIDUAL, GROUP or ORGANISATION - `uniqueDonors` integer — Total unique donors to the profile - `updatedAt` string — Date the record was last updated - `user` NestedUser - `accessToken` string — `public` A secret token for this user, used to authenticate them against the API or in your campaign. - `address1` string — `public` Line 1 of an address - `address2` string — `public` Line 2 of an address - `adminSettings` object — `public` Object containing settings for admin users - `v4BetaOptin` boolean — `public` Whether admin has opted into v4 - `starredCampaigns` string[] — `public` Array of favourite campaigns for user - `country` string — `public` The country of the user - `createdAt` string — `public` Date the record was created - `email` string — `public` The user's email address. Raisely uses this as a unique identifier and will deduplicate on email. - `facebookId` string — `public` The Facebook ID provided on authentication - `firstName` string — `public` The first name of the user - `fullName` string — `public` The full name of the user - `internal` object — `public` Internal values related to this record - `ipCity` string — `public` Deprecated - `ipCountry` string — `public` Deprecated - `ipLatitude` number — `public` Deprecated - `ipLongitude` number — `public` Deprecated - `ipNumber` string — `public` Deprecated - `isAdmin` boolean — `public` Will be true if this user has admin permissions - `isSamlLogin` boolean — `public` Will be true if this user logs in via organisation SAML login - `language` string — `public` The language the user last interacted in - `lastName` string — `public` The last name of the user - `permission` string — `public` Deprecated. Use roles - `phoneNumber` string — `public` Phone number of the user - `photoUrl` string — `public` URL of the user's photo - `postcode` string — `public` Postal code of the user - `preferredName` string — `public` The name that the user prefers to be called - `private` object — `public` Private values for this record - `public` object — `public` Public values for this record - `state` string — `public` The state/province of the user - `status` 'ACTIVE' | 'DELETED' | 'PENDING' — `public` ACTIVE, DELETED, or PENDING - `suburb` string — `public` The suburb/city of the user - `swiftAidAuthExpiry` string — `public` Date of expiry of donor authorisation for SwiftAid - `swiftAidDonorId` string — `public` Id of donor on SwiftAid - `unsubscribedAt` string — `public` ISO8601 timestamp of when the user was unsubscribed from non-essential emails or sms. A blank value indicates the user is still subscribed. - `updatedAt` string — `public` Date the record was last updated - `username` string — `public` The login email for this user - `uuid` string — `public` Unique identifier for the record - `userUuid` string — Unique identifier for the record - `uuid` string — Unique identifier for the record - `teamProfile` NestedProfile - `activityTotal` integer — `public` The total contribution of this profile towards its activity goal - `activityTotalPercent` integer — `public` The percentage of the total activity measure compared to the profile goal (out of 100) - `campaignDisplayTotal` integer — `public` The total amount raised by a profile (in the currency of the campaign) - `createdAt` string — `public` Date the record was created - `currency` string — `public` 3 letter currency code - `description` string — `public` Public description of the fundraiser profile - `donationCount` integer — `public` Total donations made to this profile and it's children. (excluded matched gifts) - `donationRecordCount` integer — `public` Every donation record on this profile regardless of status or mode (same scope as permanent-delete validation, broader than donationCount). - `exerciseGoal` integer — `public` The exercise distance goal for the profile, in metres - `exerciseGoalTime` integer — `public` The time spent exercising goal for the profile, in minutes - `exerciseTotal` integer — `public` The total distance of exercise completed, in metres - `exerciseTotalTime` integer — `public` The total amount of time exercising, in minutes - `facebookFundraiserId` string — `public` Facebook Fundraiser ID linked to the profile - `fundraiserTheme` string — `public` Path of the DIY fundraiser theme selected by the fundraiser - `goal` integer — `public` Fundraising target (in cents) - `individualProfileCount` integer — `public` Number of individual profiles that have joined this profile (or it's descendants) - `isCampaignProfile` boolean — `public` Shows true if this profile is the campaign profile - `name` string — `public` The name of the profile - `nonSelfDonationTotal` integer — `public` The total amount raised by a profile excluding self-donations (in the currency of the campaign) - `organisationProfileCount` integer — `public` Number of team profiles that have joined this profile (or it's descendants) - `paid` boolean — `public` Flagged as true if this profile was used as part of a paid registration - `path` string — `public` The path of this record (for alternative lookup) - `photoUrl` string — `public` URL of the profile photo - `private` object — `public` Private values for this record - `pronouns` string — `public` Pronouns of the profile - `public` object — `public` Public values for this record - `selfDonationTotal` integer — `public` The total amount raised by self-donations for an individual profile (in the currency of the campaign) - `shared` boolean — `public` Flag that determines if a profile has been shared by its owner - `status` 'ACTIVE' | 'DELETED' | 'PURGED' — `public` ACTIVE, DELETED, or PURGED - `subscriptionCount` integer — `public` Subscriptions associated with this profile (same scope as permanent-delete validation). - `teamProfileCount` integer — `public` Number of team profiles that have joined this profile (or it's descendants) - `type` 'INDIVIDUAL' | 'GROUP' | 'ORGANISATION' — `public` INDIVIDUAL, GROUP or ORGANISATION - `uniqueDonors` integer — `public` Total unique donors to the profile - `updatedAt` string — `public` Date the record was last updated - `uuid` string — `public` Unique identifier for the record - `organisationProfile` NestedProfile - `activityTotal` integer — `public` The total contribution of this profile towards its activity goal - `activityTotalPercent` integer — `public` The percentage of the total activity measure compared to the profile goal (out of 100) - `campaignDisplayTotal` integer — `public` The total amount raised by a profile (in the currency of the campaign) - `createdAt` string — `public` Date the record was created - `currency` string — `public` 3 letter currency code - `description` string — `public` Public description of the fundraiser profile - `donationCount` integer — `public` Total donations made to this profile and it's children. (excluded matched gifts) - `donationRecordCount` integer — `public` Every donation record on this profile regardless of status or mode (same scope as permanent-delete validation, broader than donationCount). - `exerciseGoal` integer — `public` The exercise distance goal for the profile, in metres - `exerciseGoalTime` integer — `public` The time spent exercising goal for the profile, in minutes - `exerciseTotal` integer — `public` The total distance of exercise completed, in metres - `exerciseTotalTime` integer — `public` The total amount of time exercising, in minutes - `facebookFundraiserId` string — `public` Facebook Fundraiser ID linked to the profile - `fundraiserTheme` string — `public` Path of the DIY fundraiser theme selected by the fundraiser - `goal` integer — `public` Fundraising target (in cents) - `individualProfileCount` integer — `public` Number of individual profiles that have joined this profile (or it's descendants) - `isCampaignProfile` boolean — `public` Shows true if this profile is the campaign profile - `name` string — `public` The name of the profile - `nonSelfDonationTotal` integer — `public` The total amount raised by a profile excluding self-donations (in the currency of the campaign) - `organisationProfileCount` integer — `public` Number of team profiles that have joined this profile (or it's descendants) - `paid` boolean — `public` Flagged as true if this profile was used as part of a paid registration - `path` string — `public` The path of this record (for alternative lookup) - `photoUrl` string — `public` URL of the profile photo - `private` object — `public` Private values for this record - `pronouns` string — `public` Pronouns of the profile - `public` object — `public` Public values for this record - `selfDonationTotal` integer — `public` The total amount raised by self-donations for an individual profile (in the currency of the campaign) - `shared` boolean — `public` Flag that determines if a profile has been shared by its owner - `status` 'ACTIVE' | 'DELETED' | 'PURGED' — `public` ACTIVE, DELETED, or PURGED - `subscriptionCount` integer — `public` Subscriptions associated with this profile (same scope as permanent-delete validation). - `teamProfileCount` integer — `public` Number of team profiles that have joined this profile (or it's descendants) - `type` 'INDIVIDUAL' | 'GROUP' | 'ORGANISATION' — `public` INDIVIDUAL, GROUP or ORGANISATION - `uniqueDonors` integer — `public` Total unique donors to the profile - `updatedAt` string — `public` Date the record was last updated - `uuid` string — `public` Unique identifier for the record ## Other responses - `401` — Authorization credentials were missing or invalid - `403` — The user is authenticated, but is not allowed to perform the requested operation - `410` — The requested record no longer exists, or that API has been deprecated - `429` — You have made too many requests to the given endpoint, please try again later - `500` — An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com --- [API](https://skmtc.net/raisely/apis/raisely-api.md) · [All operations](https://skmtc.net/raisely/apis/raisely-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/raisely/raisely-api/versions/d7f8dd294cb0/schema)