--- title: "join" method: PATCH path: "/profiles/{path}/join" tags: ["Profiles"] --- # join `PATCH /profiles/{path}/join` 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 ## Path parameters - `path` string, required ## Query parameters - `private` boolean ## Headers - `Authorization` string ## Request body - object - `parentUuid` string — The uuid of the profile to join ## Response `200` The result of joining or leaving a profile - object - `data` JoinProfileResult - `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) - `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 - `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) - `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` CreateResultUserSignup - `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 - `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 - `organisationUuid` string — `public` Unique identifier for the record - `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 - `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 - `parentUuid` string — `public` Unique identifier for the record - `parent` NestedParentJoinProfileResponse - `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 - `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). - `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 - `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) - `path` string — `public` The path of this record (for alternative lookup) - `pronouns` string — `public` Pronouns of the profile - `selfDonationTotal` integer — `public` The total amount raised by self-donations for an individual profile (in the currency of the campaign) - `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 - `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 - `user` CreateResultUserSignup - `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 - `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 - `organisationUuid` string — `public` Unique identifier for the record - `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 - `tags` NestedTag[] — `public` - `color` string — `public` The color used to display this tag within the admin interface - `createdAt` string — `public` Date the record was created - `internal` object — `public` Internal values related to this record - `isPrivate` boolean — `public` Indicates if this tag is publicly available - `label` string — `public` The text used to identity this tag within the admin interface - `organisationUuid` string — `public` Unique identifier for the record - `path` string — `public` The path of this record (for alternative lookup) - `recordType` string — `public` The type of record represented by this tag - `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)