> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.getkard.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getkard.com/_mcp/server. # Update User PUT https://rewards-api.getkard.com/users/users/{id} Content-Type: application/json Call this endpoint to update the details on a specified user. If you would like to add a card to a specified user, please refer to the [Create User Card endpoint](/legacy/api/users/create-user-card). Required scopes: `user:update` Reference: https://docs.getkard.com/api/users/update ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://rewards-api.getkard.com` (Production, default) - `https://test-rewards-api.getkard.com` (Sandbox) ## Request ### Path parameters - `id` (string, required) — Referring partner user ID from issuer that specifies user ### Body (application/json) This endpoint expects an UserRequestBody. - `referringPartnerUserId` (string, required) — Referring partner user ID of user from issuer. Must be a unique identifier across users - `email` (string, optional) — Email of user - `hashedEmail` (string, optional) — Hashed email address of user (using SHA-256) - `phoneNumber` (string, optional) — Phone number of user in E.164 format - `birthYear` (string, optional) — Birth year of user - `userName` (string, optional) — Username of user from issuer - `firstName` (string, optional) — First name of user - `lastName` (string, optional) — Last name of user - `zipCode` (string, optional) — Zipcode of user - `externalPartnerUserId` (string, optional) — Partner unique user id, might be equal to referringPartnerUserId - `enrolledRewards` (list of enum, optional) — An empty array will unenroll user from all programs. Note, please do not send AFFILIATE as this field has been deprecated. - Allowed values: `CARDLINKED`, `AFFILIATE` ## Response ### 200 - `referringPartnerUserId` (string, required) — Referring partner user ID of user from issuer. Must be a unique identifier across users - `enrolledRewards` (list of enum, optional) — List of enrolled rewards - Allowed values: `CARDLINKED`, `AFFILIATE` - `email` (string, optional) — Email of user if available - `hashedEmail` (string, optional) — Hashed email address of user (using SHA-256) - `phoneNumber` (string, optional) — Phone number of user in E.164 format - `birthYear` (string, optional) — Birth year of user - `firstName` (string, optional) — First name of user if available - `lastName` (string, optional) — Last name of user if available - `zipCode` (string, optional) — Zipcode of user if available - `cards` (list of CardInfoResponse, optional) — List of User Cards Information - `userName` (string, optional) — Username of user from issuer if available ## Errors ### 401 Unauthorized Error - `message` (string, required) ### 400 Invalid Request - `InvalidRequestUnion` ### 500 Internal Server Error - `string` ### 404 Does Not Exist Error - `string` ## Types ### CardInfoResponse Credit Card Information - `_id` (string, required) — Card ID in Kard's system - `last4` (string, required) — Card last four digits. Note, this field is REQUIRED for matching purposes. - `bin` (string, required) — Bank identification number (BIN). Must be a valid BIN of 6 digits. If over 6 digits, please send first 6.Note, this field is REQUIRED for matching purposes. - `issuer` (string, required) — Issuer name - `network` (enum, required) — Name of card network - Allowed values: `VISA`, `MASTERCARD`, `AMERICAN EXPRESS`, `DISCOVER` - `status` (enum, required) — Status of the card - Allowed values: `ENABLED`, `DISABLED` - `token` (string, optional) — Card token - `tokenSource` (string, optional) — Card token source ### RequestValidationErrorResponse - `errors` (list of string, required) ## Examples **Request** ```json { "referringPartnerUserId": "123abc345efg", "email": "someone@email.com", "hashedEmail": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456", "phoneNumber": "+12345678901", "birthYear": "1990", "userName": "some_user_name", "firstName": "John", "lastName": "Doe", "zipCode": "10028", "externalPartnerUserId": "1234567890", "enrolledRewards": [ "CARDLINKED" ] } ``` **Response** ```json { "referringPartnerUserId": "1234567890", "enrolledRewards": [ "CARDLINKED" ], "email": "someone@email.com", "hashedEmail": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456", "phoneNumber": "+12345678901", "birthYear": "1990", "firstName": "John", "lastName": "Doe", "zipCode": "10028", "cards": [ { "_id": "some_id", "last4": "1234", "bin": "567890", "issuer": "Name_Of_Issuer", "network": "VISA", "status": "ENABLED" } ], "userName": "some_user_name" } ``` **SDK Code** ```python import requests url = "https://rewards-api.getkard.com/users/users/%7Bid%7D" payload = { "referringPartnerUserId": "123abc345efg", "email": "someone@email.com", "hashedEmail": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456", "phoneNumber": "+12345678901", "birthYear": "1990", "userName": "some_user_name", "firstName": "John", "lastName": "Doe", "zipCode": "10028", "externalPartnerUserId": "1234567890", "enrolledRewards": ["CARDLINKED"] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://rewards-api.getkard.com/users/users/%7Bid%7D'; const options = { method: 'PUT', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"referringPartnerUserId":"123abc345efg","email":"someone@email.com","hashedEmail":"a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456","phoneNumber":"+12345678901","birthYear":"1990","userName":"some_user_name","firstName":"John","lastName":"Doe","zipCode":"10028","externalPartnerUserId":"1234567890","enrolledRewards":["CARDLINKED"]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://rewards-api.getkard.com/users/users/%7Bid%7D" payload := strings.NewReader("{\n \"referringPartnerUserId\": \"123abc345efg\",\n \"email\": \"someone@email.com\",\n \"hashedEmail\": \"a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456\",\n \"phoneNumber\": \"+12345678901\",\n \"birthYear\": \"1990\",\n \"userName\": \"some_user_name\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"zipCode\": \"10028\",\n \"externalPartnerUserId\": \"1234567890\",\n \"enrolledRewards\": [\n \"CARDLINKED\"\n ]\n}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://rewards-api.getkard.com/users/users/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"referringPartnerUserId\": \"123abc345efg\",\n \"email\": \"someone@email.com\",\n \"hashedEmail\": \"a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456\",\n \"phoneNumber\": \"+12345678901\",\n \"birthYear\": \"1990\",\n \"userName\": \"some_user_name\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"zipCode\": \"10028\",\n \"externalPartnerUserId\": \"1234567890\",\n \"enrolledRewards\": [\n \"CARDLINKED\"\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://rewards-api.getkard.com/users/users/%7Bid%7D") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"referringPartnerUserId\": \"123abc345efg\",\n \"email\": \"someone@email.com\",\n \"hashedEmail\": \"a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456\",\n \"phoneNumber\": \"+12345678901\",\n \"birthYear\": \"1990\",\n \"userName\": \"some_user_name\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"zipCode\": \"10028\",\n \"externalPartnerUserId\": \"1234567890\",\n \"enrolledRewards\": [\n \"CARDLINKED\"\n ]\n}") .asString(); ``` ```php request('PUT', 'https://rewards-api.getkard.com/users/users/%7Bid%7D', [ 'body' => '{ "referringPartnerUserId": "123abc345efg", "email": "someone@email.com", "hashedEmail": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456", "phoneNumber": "+12345678901", "birthYear": "1990", "userName": "some_user_name", "firstName": "John", "lastName": "Doe", "zipCode": "10028", "externalPartnerUserId": "1234567890", "enrolledRewards": [ "CARDLINKED" ] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://rewards-api.getkard.com/users/users/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"referringPartnerUserId\": \"123abc345efg\",\n \"email\": \"someone@email.com\",\n \"hashedEmail\": \"a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456\",\n \"phoneNumber\": \"+12345678901\",\n \"birthYear\": \"1990\",\n \"userName\": \"some_user_name\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"zipCode\": \"10028\",\n \"externalPartnerUserId\": \"1234567890\",\n \"enrolledRewards\": [\n \"CARDLINKED\"\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "referringPartnerUserId": "123abc345efg", "email": "someone@email.com", "hashedEmail": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456", "phoneNumber": "+12345678901", "birthYear": "1990", "userName": "some_user_name", "firstName": "John", "lastName": "Doe", "zipCode": "10028", "externalPartnerUserId": "1234567890", "enrolledRewards": ["CARDLINKED"] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://rewards-api.getkard.com/users/users/%7Bid%7D")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```