---
title: "signup"
method: POST
path: "/signup"
tags: ["Authentication"]
---

# signup

`POST /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](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper

## Headers

- `Authorization` string

## Request body

- object
  - `campaignUuid` string — The UUID of the campaign the signup was initiated under (this will affect the email they receive)
  - `data` object
    - `address1` string — Line 1 of an address Example: `31 Sunset Boulevard`
    - `address2` string — Line 2 of an address Example: `Unit 31b`
    - `adminSettings` object — Object containing settings for admin users
    - `country` string — The country of the user Examples: `AU`, `GB`, `US`
    - `email` string — The user's email address. Raisely uses this as a unique identifier and will deduplicate on email. Example: `harveymilk@example.com`
    - `firstName` string — The first name of the user Example: `Leila`
    - `fullName` string — The full name of the user Example: `Leila Norma de Lima`
    - `isSamlLogin` boolean — Will be true if this user logs in via organisation SAML login Examples: `true`, `false`
    - `language` string — The language the user last interacted in
    - `lastName` string — The last name of the user Example: `de Lima`
    - `phoneNumber` string — Phone number of the user Example: `+1 123-456-7890`
    - `photoUrl` string — URL of the user's 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`
    - `postcode` string — Postal code of the user Examples: `AAA BBBB`, `0000`, `AAA BBB`
    - `preferredName` string — The name that the user prefers to be called Example: `Norma`
    - `private` object — Private values for this record Example: `{ "fieldA": "one", "fieldB": "yes" }`
    - `public` object — Public values for this record Example: `{ "fieldA": "one", "fieldB": "yes" }`
    - `state` string — The state/province of the user Examples: `Victoria`, `New York`, `British Columbia`
    - `suburb` string — The suburb/city of the user Examples: `Melbourne`, `Albany`, `Vancouver`
    - `swiftAidAuthExpiry` string — Date of expiry of donor authorisation for SwiftAid
    - `password` string, required — Password for the new user account

## Response `200`

The created User model (public only)

- object
  - `data` 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
  - `message` string — A human-friendly message you can display to your user to ask them to confirm their account.
  - `token` string — A bearer token for the new user that can be used for future API requests.

## 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.dev/raisely/apis/raisely-api.md) · [All operations](https://skmtc.dev/raisely/apis/raisely-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/raisely/raisely-api/revisions/d7f8dd294cb0/schema)