v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Profiles

add member

Create a new member on the parent profile.

Owner of the member profile: data.userUuid is optional. When supplied it identifies the existing user who will own the member profile; under campaign API key authentication (Authorization header, Bearer raisely-sk-...) with the explicit-user rollout enabled, the user must belong to the same organisation as the campaign — a userUuid from another organisation returns 404 not found. When data.userUuid is omitted, the member defaults to the authenticated user (for a campaign API key that is the key owner).

For custom components:

RaiselyComponents.api.one('profiles', '{path}').all('members').post(data = {}, params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

post/profiles/{path}/members

Path parameters

pathstring required

The uuid or path of the record

Query parameters

campaignstring

The uuid, path or domain of the campaign to associate with the request

privateboolean

Returns the full record when authenticated

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Request body

Example request

{
  "data": {
    "currency": "AUD",
    "description": "I believe in a better world",
    "exerciseGoal": 12345,
    "exerciseGoalTime": 12345,
    "fundraiserTheme": "birthday",
    "goal": 100050,
    "name": "Bob D.",
    "path": "bobd",
    "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
    "private": {
      "fieldA": "one",
      "fieldB": "yes"
    },
    "public": {
      "fieldA": "one",
      "fieldB": "yes"
    },
    "type": "INDIVIDUAL",
    "userUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Response

The created Profile record

Example response

{
  "data": {
    "activityTotal": 2625,
    "activityTotalPercent": 2625,
    "campaignDisplayTotal": 2625,
    "createdAt": "2020-12-03T06:52:46.330Z",
    "currency": "AUD",
    "description": "I believe in a better world",
    "donationCount": 12345,
    "donationRecordCount": 12345,
    "exerciseGoal": 12345,
    "exerciseGoalTime": 12345,
    "exerciseTotal": 2625,
    "exerciseTotalTime": 2625,
    "fundraiserTheme": "birthday",
    "goal": 100050,
    "individualProfileCount": 12345,
    "isCampaignProfile": true,
    "name": "Bob D.",
    "nonSelfDonationTotal": 2625,
    "organisationProfileCount": 12345,
    "paid": true,
    "path": "bobd",
    "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
    "public": {
      "fieldA": "one",
      "fieldB": "yes"
    },
    "selfDonationTotal": 2625,
    "status": "ACTIVE",
    "subscriptionCount": 12345,
    "teamProfileCount": 12345,
    "type": "INDIVIDUAL",
    "uniqueDonors": 12345,
    "updatedAt": "2020-12-03T06:52:46.330Z",
    "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "teamProfile": {
      "activityTotal": 2625,
      "activityTotalPercent": 2625,
      "campaignDisplayTotal": 2625,
      "createdAt": "2020-12-03T06:52:46.330Z",
      "currency": "AUD",
      "description": "I believe in a better world",
      "donationCount": 12345,
      "donationRecordCount": 12345,
      "exerciseGoal": 12345,
      "exerciseGoalTime": 12345,
      "exerciseTotal": 2625,
      "exerciseTotalTime": 2625,
      "fundraiserTheme": "birthday",
      "goal": 100050,
      "individualProfileCount": 12345,
      "isCampaignProfile": true,
      "name": "Bob D.",
      "nonSelfDonationTotal": 2625,
      "organisationProfileCount": 12345,
      "paid": true,
      "path": "bobd",
      "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
      "private": {
        "fieldA": "one",
        "fieldB": "yes"
      },
      "public": {
        "fieldA": "one",
        "fieldB": "yes"
      },
      "selfDonationTotal": 2625,
      "shared": true,
      "status": "ACTIVE",
      "subscriptionCount": 12345,
      "teamProfileCount": 12345,
      "type": "INDIVIDUAL",
      "uniqueDonors": 12345,
      "updatedAt": "2020-12-03T06:52:46.330Z",
      "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
    },
    "organisationProfile": {
      "activityTotal": 2625,
      "activityTotalPercent": 2625,
      "campaignDisplayTotal": 2625,
      "createdAt": "2020-12-03T06:52:46.330Z",
      "currency": "AUD",
      "description": "I believe in a better world",
      "donationCount": 12345,
      "donationRecordCount": 12345,
      "exerciseGoal": 12345,
      "exerciseGoalTime": 12345,
      "exerciseTotal": 2625,
      "exerciseTotalTime": 2625,
      "fundraiserTheme": "birthday",
      "goal": 100050,
      "individualProfileCount": 12345,
      "isCampaignProfile": true,
      "name": "Bob D.",
      "nonSelfDonationTotal": 2625,
      "organisationProfileCount": 12345,
      "paid": true,
      "path": "bobd",
      "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
      "private": {
        "fieldA": "one",
        "fieldB": "yes"
      },
      "public": {
        "fieldA": "one",
        "fieldB": "yes"
      },
      "selfDonationTotal": 2625,
      "shared": true,
      "status": "ACTIVE",
      "subscriptionCount": 12345,
      "teamProfileCount": 12345,
      "type": "INDIVIDUAL",
      "uniqueDonors": 12345,
      "updatedAt": "2020-12-03T06:52:46.330Z",
      "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
    }
  }
}