--- title: "update user" method: PATCH path: "/users/{uuid}" tags: ["Users"] --- # update user `PATCH /users/{uuid}` Update the specified **user**. #### For custom components: `RaiselyComponents.api.one('users', '{uuid}').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 - `uuid` string, required ## Query parameters - `private` boolean ## Headers - `Authorization` string ## Request body - object - `data` UpdateUser - `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 - `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 User record - object - `data` UpdateResultUser - `accessToken` string — A secret token for this user, used to authenticate them against the API or in your campaign. - `address1` string — Line 1 of an address - `address2` string — Line 2 of an address - `adminSettings` object — Object containing settings for admin users - `v4BetaOptin` boolean — Whether admin has opted into v4 - `starredCampaigns` string[] — Array of favourite campaigns for user - `country` string — The country of the user - `createdAt` string — Date the record was created - `email` string — The user's email address. Raisely uses this as a unique identifier and will deduplicate on email. - `facebookId` string — The Facebook ID provided on authentication - `firstName` string — The first name of the user - `fullName` string — The full name of the user - `internal` object — Internal values related to this record - `ipCity` string — Deprecated - `ipCountry` string — Deprecated - `ipLatitude` number — Deprecated - `ipLongitude` number — Deprecated - `ipNumber` string — Deprecated - `isAdmin` boolean — Will be true if this user has admin permissions - `isSamlLogin` boolean — Will be true if this user logs in via organisation SAML login - `language` string — The language the user last interacted in - `lastName` string — The last name of the user - `organisationUuid` string — Unique identifier for the record - `permission` string — Deprecated. Use roles - `phoneNumber` string — Phone number of the user - `photoUrl` string — URL of the user's photo - `postcode` string — Postal code of the user - `preferredName` string — The name that the user prefers to be called - `private` object — Private values for this record - `public` object — Public values for this record - `state` string — The state/province of the user - `status` 'ACTIVE' | 'DELETED' | 'PENDING' — ACTIVE, DELETED, or PENDING - `suburb` string — The suburb/city of the user - `swiftAidAuthExpiry` string — Date of expiry of donor authorisation for SwiftAid - `swiftAidDonorId` string — Id of donor on SwiftAid - `tags` NestedTag[] - `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 - `unsubscribedAt` string — 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 — Date the record was last updated - `username` string — The login email for this user - `uuid` string — Unique identifier for the record ## Other responses - `400` — The request requires a body, but the body was missing - `401` — Authorization credentials were missing or invalid - `403` — The user is authenticated, but is not allowed to perform the requested operation - `404` — One of the records needed to complete the request could not be found - `409` — The operation cannot be completed because it would result in a duplicate record - `410` — The requested record no longer exists, or that API has been deprecated - `412` — Operation cannot proceed with the record in it's current state - `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)