signup
Sign up a new user to your campaign. If the user you are registering is unknown you'll receive a token for the new user to use for future authenticated requests. If the user already exists in your organisation's database, they will be sent the Account Confirmation email and the API will return a human-friendly message. <br> Note: Using /signup won't create a fundraising profile. You can create a profile later, or you can use /register. We recommend using /register when signing up a new fundraiser to a campaign.
For custom components:
RaiselyComponents.api.all('signup').post(data = {}, params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
Headers
A valid HTTP Bearer token, required to access private records.
Request body
Example request
{
"campaignUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"data": {
"address1": "31 Sunset Boulevard",
"address2": "Unit 31b",
"country": "AU",
"email": "harveymilk@example.com",
"firstName": "Leila",
"fullName": "Leila Norma de Lima",
"isSamlLogin": true,
"lastName": "de Lima",
"phoneNumber": "+1 123-456-7890",
"photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
"postcode": "AAA BBBB",
"preferredName": "Norma",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"state": "Victoria",
"suburb": "Melbourne"
}
}Response
The created User model (public only)
Example response
{
"data": {
"address1": "31 Sunset Boulevard",
"address2": "Unit 31b",
"adminSettings": {
"v4BetaOptin": true,
"starredCampaigns": [
"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj"
]
},
"country": "AU",
"createdAt": "2020-12-03T06:52:46.330Z",
"email": "harveymilk@example.com",
"facebookId": "fb_someurl",
"firstName": "Leila",
"fullName": "Leila Norma de Lima",
"isAdmin": true,
"isSamlLogin": true,
"lastName": "de Lima",
"organisationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"permission": "PARTICIPANT",
"phoneNumber": "+1 123-456-7890",
"photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
"postcode": "AAA BBBB",
"preferredName": "Norma",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"state": "Victoria",
"status": "ACTIVE",
"suburb": "Melbourne",
"unsubscribedAt": "2020-12-03T06:52:46.330Z",
"updatedAt": "2020-12-03T06:52:46.330Z",
"username": "harveymilk@example.com",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
},
"message": "Check your email to finish the sign up process",
"token": "yJ0eXAiOiJKV1QiLCJhbGciOiJIUz..."
}