--- updatedAt: 2026-05-11T06:52:59.000Z agentTools: projectIndex: https://platform.simpplr.com/llms.txt --- # Update user (all fields) This API allows you to update a user by ID (all fields required) # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "version": "1.0.0", "title": "Simpplr B2B API Documentation", "description": "API documentation for Simpplr B2B integration services", "contact": { "name": "Simpplr Support" } }, "x-proxy-enabled": true, "tags": [ { "name": "Feed", "description": "Everything about Feed" }, { "name": "Users", "description": "Everything about Users" } ], "servers": [ { "url": "https://{endpoint}/v1", "variables": { "env": { "default": "app" }, "endpoint": { "default": "platform.app.simpplr.com" } } } ], "paths": { "/b2b/identity/users/{userId}": { "get": { "operationId": "getUser", "tags": [ "Users" ], "summary": "Get User by ID", "description": "This API allows you to get a user by ID", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the user to get", "required": true, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "parseCustomFields", "in": "query", "description": "Whether to parse custom fields (if custom field types enabled)", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ], "default": "false" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the user", "example": "55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "username": { "type": "string", "description": "User's username", "example": "jhon.smith" }, "status": { "type": "string", "description": "User's status", "example": "Active" }, "firstName": { "type": "string", "description": "User's first name", "example": "Jhon" }, "lastName": { "type": "string", "description": "User's last name", "example": "smith" }, "pronouns": { "type": "string", "description": "User's pronouns", "example": "he/him" }, "pronunciationUrl": { "type": "string", "description": "URL to the user's pronunciation", "example": "/pronunciation/55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "email": { "type": "string", "description": "User's email address", "example": "jhon.smith@example.com" }, "mobile": { "type": "string", "description": "User's mobile phone number", "example": "234567890" }, "phone": { "type": "string", "description": "User's phone number", "example": "234567890" }, "extn": { "type": "string", "description": "User's extension", "example": "+91" }, "about": { "type": "string", "description": "User's about", "example": "I am a software engineer" }, "photo": { "type": "string", "description": "URL to the user's photo", "example": "/photo/55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "employeeNumber": { "type": "string", "description": "User's employee number", "example": "123456" }, "coverImage": { "type": "string", "description": "URL to the user's cover image", "example": "/cover-image/55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "birthDayDay": { "type": "string", "description": "User's birth day", "example": "30" }, "birthDayMonth": { "type": "string", "description": "User's birth month", "example": "10" }, "peopleCategory": { "type": "string", "description": "User's people category", "example": "Employee" }, "segmentId": { "type": "string", "description": "User's segment id", "example": "55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "timezone": { "type": "string", "description": "User's timezone", "example": "Asia/Kolkata" }, "locale": { "type": "string", "description": "User's locale", "example": "en_IN" }, "reprovOn": { "type": "string", "description": "User's reprovisioning date", "example": "2021-01-01" }, "deprovOn": { "type": "string", "description": "User's deprovisioning date", "example": "2021-01-01" }, "managerId": { "type": "string", "description": "User's manager id", "example": "55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "assistantId": { "type": "string", "description": "User's assistant id", "example": "55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "isEmailDisplayable": { "type": "boolean", "description": "Whether the user's assistant email is displayable", "example": true }, "isMobileDisplayable": { "type": "boolean", "description": "Whether the user's assistant mobile is displayable", "example": true }, "isPhoneDisplayable": { "type": "boolean", "description": "Whether the user's assistant phone is displayable", "example": true }, "zoom": { "type": "string", "description": "User's zoom url", "example": "https://zoom.us/j/1234567890" }, "skype": { "type": "string", "description": "User's skype url", "example": "https://skype.com/jhon.smith" }, "linkedInUrl": { "type": "string", "description": "User's linkedin url", "example": "https://linkedin.com/in/jhon.smith" }, "twitterUrl": { "type": "string", "description": "User's twitter url", "example": "https://twitter.com/jhon.smith" }, "facebookUrl": { "type": "string", "description": "User's facebook url", "example": "https://facebook.com/jhon.smith" }, "youtubeUrl": { "type": "string", "description": "User's youtube url", "example": "https://youtube.com/jhon.smith" }, "instagramUrl": { "type": "string", "description": "User's instagram url", "example": "https://instagram.com/jhon.smith" }, "payCurrency": { "type": "string", "description": "User's pay currency", "example": "USD" }, "createdOn": { "type": "string", "description": "User's creation timestamp", "example": "2024-12-18T12:54:06.729Z" }, "modifiedOn": { "type": "string", "description": "User's update timestamp", "example": "2024-12-18T12:54:06.729Z" }, "licenseType": { "type": "string", "description": "User's license type", "example": "Corporate" }, "addressLine1": { "type": "string", "description": "User's address line 1", "example": "123 Main St" }, "addressLine2": { "type": "string", "description": "User's address line 2", "example": "Apt 1" }, "city": { "type": "string", "description": "User's city", "example": "New York" }, "state": { "type": "string", "description": "User's state", "example": "NY" }, "postalCode": { "type": "string", "description": "User's postal code", "example": "10001" }, "country": { "type": "string", "description": "User's country", "example": "USA" }, "title": { "type": "string", "description": "User's title", "example": "Software Engineer" }, "department": { "type": "string", "description": "User's department", "example": "Engineering" }, "division": { "type": "string", "description": "User's division", "example": "Engineering" }, "businessUnit": { "type": "string", "description": "User's business unit", "example": "Engineering" }, "companyName": { "type": "string", "description": "User's company name", "example": "Example Inc." }, "startDate": { "type": "string", "description": "User's start date", "example": "2024-12-18" }, "userType": { "type": "string", "description": "User's user type", "example": "Employee" }, "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "User's custom fields (if applicable)\nif parseCustomFields is true and custom field types is enabled; then multi-select custom fields will be returned as an array of strings else it will be returned as a string with semicolons (;) separated values\n" }, "^.*__c$": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "User's custom fields (if applicable) \nif parseCustomFields is true and custom field types is enabled; then multi-select custom fields will be returned as an array of strings else it will be returned as a string with semicolons (;) separated values\n" } } } } } }, "400": { "description": "Validation Error Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error message indicating validation failure", "example": "Invalid user ID" }, "errors": { "type": "array", "description": "List of validation errors", "items": { "type": "object", "properties": { "pathParam": { "type": "string", "description": "Name of the parameter that failed validation", "example": "userId" }, "message": { "type": "string", "description": "Detailed error message for the validation failure", "example": "Invalid user ID" } }, "required": [ "pathParam", "message" ] } } }, "required": [ "message", "errors" ] } } } }, "401": { "$ref": "#/paths/~1b2b~1rfeed~1feeds/get/responses/401" }, "403": { "$ref": "#/paths/~1b2b~1rfeed~1feeds/get/responses/403" }, "404": { "description": "not found error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error message indicating validation failure", "example": "User not found" } }, "required": [ "message" ] } } } } } }, "put": { "operationId": "updateUserPut", "tags": [ "Users" ], "summary": "Update user (all fields)", "description": "This API allows you to update a user by ID (all fields required)\n", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the user to update", "required": true, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } } ], "requestBody": { "description": "The user object to update\nNote: if birthDate is provided, birthDayDay and birthDayMonth are not required and vice versa.\nListed below are 2 kind of payloads:\n1) birthDate is provided\n2) birthDayDay and birthDayMonth are provided\n", "content": { "application/json": { "schema": { "type": "object", "description": "Update user request", "properties": { "username": { "type": "string", "description": "User's username", "example": "jhon.smith" }, "status": { "type": "string", "description": "User's status", "enum": [ "Active", "Inactive", "Freezed" ] }, "firstName": { "type": "string", "description": "User's first name", "example": "Jhon" }, "lastName": { "type": "string", "description": "User's last name", "example": "smith" }, "pronouns": { "type": "string", "description": "User's pronouns", "example": "he/him" }, "pronunciationUrl": { "type": "string", "description": "URL to the user's pronunciation", "example": "/pronunciation/55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "email": { "type": "string", "description": "User's email address", "example": "jhon.smith@example.com" }, "mobile": { "type": "string", "description": "User's mobile phone number", "example": "234567890" }, "phone": { "type": "string", "description": "User's phone number", "example": "234567890" }, "extn": { "type": "string", "description": "User's extension", "example": "+91" }, "about": { "type": "string", "description": "User's about", "example": "I am a software engineer" }, "photo": { "type": "string", "description": "URL to the user's photo", "example": "/photo/55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "employeeNumber": { "type": "string", "description": "User's employee number", "example": "123456" }, "coverImage": { "type": "string", "description": "URL to the user's cover image", "example": "/cover-image/55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "photoFileId": { "type": "string", "format": "uuid", "description": "File id of the user's photo", "example": "55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "coverImageFileId": { "type": "string", "format": "uuid", "description": "File id of the user's cover image", "example": "55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "peopleCategory": { "type": "string", "description": "User's people category", "example": "Employee" }, "timezone": { "type": "string", "description": "User's timezone", "example": "Asia/Kolkata" }, "locale": { "type": "string", "description": "User's locale", "example": "en_IN" }, "managerId": { "type": "string", "description": "User's manager id", "example": "55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "assistantId": { "type": "string", "description": "User's assistant id", "example": "55526ef2-752a-47e3-affa-2fa0eaadc5eb" }, "isEmailDisplayable": { "type": "boolean", "description": "Whether the user's assistant email is displayable", "example": true }, "isMobileDisplayable": { "type": "boolean", "description": "Whether the user's assistant mobile is displayable", "example": true }, "isPhoneDisplayable": { "type": "boolean", "description": "Whether the user's assistant phone is displayable", "example": true }, "zoom": { "type": "string", "description": "User's zoom url", "example": "https://zoom.us/j/1234567890" }, "skype": { "type": "string", "description": "User's skype url", "example": "https://skype.com/jhon.smith" }, "linkedInUrl": { "type": "string", "description": "User's linkedin url", "example": "https://linkedin.com/in/jhon.smith" }, "twitterUrl": { "type": "string", "description": "User's twitter url", "example": "https://twitter.com/jhon.smith" }, "facebookUrl": { "type": "string", "description": "User's facebook url", "example": "https://facebook.com/jhon.smith" }, "youtubeUrl": { "type": "string", "description": "User's youtube url", "example": "https://youtube.com/jhon.smith" }, "instagramUrl": { "type": "string", "description": "User's instagram url", "example": "https://instagram.com/jhon.smith" }, "payCurrency": { "type": "string", "description": "User's pay currency", "example": "USD", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UZS", "VED", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWL" ] }, "licenseType": { "type": "string", "description": "User's license type", "example": "Corporate" }, "addressLine1": { "type": "string", "description": "User's address line 1", "example": "123 Main St" }, "addressLine2": { "type": "string", "description": "User's address line 2", "example": "Apt 1" }, "city": { "type": "string", "description": "User's city", "example": "New York" }, "state": { "type": "string", "description": "User's state", "example": "NY" }, "postalCode": { "type": "string", "description": "User's postal code", "example": "10001" }, "country": { "type": "string", "description": "User's country", "example": "USA" }, "title": { "type": "string", "description": "User's title", "example": "Software Engineer" }, "department": { "type": "string", "description": "User's department", "example": "Engineering" }, "division": { "type": "string", "description": "User's division", "example": "Engineering" }, "businessUnit": { "type": "string", "description": "User's business unit", "example": "Engineering" }, "companyName": { "type": "string", "description": "User's company name", "example": "Example Inc." }, "startDate": { "type": "string", "description": "User's start date", "example": "2024-12-18" }, "userType": { "type": "string", "description": "User's user type", "example": "Employee" }, "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "User's custom fields (if applicable) (pass it as string if custom field types is not enabled)\nFor multi-select custom fields, pass it as an array of strings or as a string with semicolons (;) separated values\nFor date custom fields, pass it as a string in `YYYY-MM-DD` format\n" }, "^.*__c$": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "User's custom fields (if applicable) (pass it as string if custom field types is not enabled)\nFor multi-select custom fields, pass it as an array of strings or as a string with semicolons (;) separated values\nFor date custom fields, pass it as a string in `YYYY-MM-DD` format \n" } }, "required": [ "username", "status", "firstName", "lastName", "pronouns", "pronunciationUrl", "email", "mobile", "phone", "extn", "about", "photo", "employeeNumber", "coverImage", "peopleCategory", "timezone", "locale", "managerId", "assistantId", "isEmailDisplayable", "isMobileDisplayable", "isPhoneDisplayable", "zoom", "skype", "linkedInUrl", "twitterUrl", "facebookUrl", "youtubeUrl", "instagramUrl", "payCurrency", "licenseType", "addressLine1", "addressLine2", "city", "state", "postalCode", "country", "title", "department", "division", "businessUnit", "companyName", "startDate", "userType", "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "^.*__c$" ], "oneOf": [ { "properties": { "birthDate": { "type": "string", "description": "User's birth date `YYYY-MM-DD` or `MM-DD` format\n", "example": "12-18" } }, "required": [ "birthDate" ] }, { "properties": { "birthDayDay": { "type": "string", "description": "User's birth day", "example": "30" }, "birthDayMonth": { "type": "string", "description": "User's birth month", "example": "10" } }, "required": [ "birthDayDay", "birthDayMonth" ] } ] } } } }, "responses": { "204": { "description": "User updated successfully" }, "400": { "description": "Validation Error Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error message indicating validation failure", "example": "Invalid user object" }, "errors": { "type": "array", "description": "List of validation errors", "oneOf": [ { "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Name of the parameter that failed validation", "example": "firstName" }, "message": { "type": "string", "description": "Detailed error message for the validation failure", "example": "Invalid first name" } }, "required": [ "fieldName", "message" ] } }, { "items": { "type": "object", "properties": { "pathParam": { "type": "string", "description": "Name of the parameter that failed validation", "example": "userId" }, "message": { "type": "string", "description": "Detailed error message for the validation failure", "example": "Invalid user ID" } }, "required": [ "pathParam", "message" ] } } ] } }, "required": [ "message", "errors" ] } } } }, "401": { "$ref": "#/paths/~1b2b~1rfeed~1feeds/get/responses/401" }, "403": { "$ref": "#/paths/~1b2b~1rfeed~1feeds/get/responses/403" }, "404": { "$ref": "#/paths/~1b2b~1identity~1users~1{userId}/get/responses/404" } } } }, "/b2b/rfeed/feeds": { "get": { "operationId": "getFeedsUser", "tags": [ "Feed" ], "summary": "Get feeds", "description": "This API allows you to retrieve all feeds", "parameters": [ { "name": "nextPageToken", "in": "query", "required": true, "description": "Token for pagination. \n- For initial request, send empty string \"\"\n- For subsequent requests, use the nextPageToken returned as integer from previous response\n", "schema": { "type": "string", "example": "1759911721822" } }, { "name": "size", "in": "query", "required": true, "description": "The number of feeds to return per page", "schema": { "type": "string", "example": "16" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "createdAt", "lastActivityAt" ], "default": "createdAt" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all" ], "default": "all" }, "description": "The filter to apply to the feeds" }, { "name": "feedContext", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "home", "site", "content" ], "default": "home" }, "description": "The context of the feeds. \n- When set to \"site\", siteId parameter is required\n- When set to \"content\", both siteId and contentId parameters are required\n" }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "post", "question" ], "example": "post", "description": "The type of feed to return" } }, { "name": "siteId", "in": "query", "required": false, "schema": { "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "description": "The ID of the site. \nRequired when feedContext is \"site\" or \"content\"\n" }, { "name": "contentId", "in": "query", "required": false, "schema": { "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "description": "The ID of the content.\nRequired when feedContext is \"content\"\n" }, { "name": "feedIds", "in": "query", "required": false, "schema": { "type": "string", "example": "97576a5d-4362-40cb-b8ac-5418b64bf84f,6d54cb3d-da29-461b-8019-3dfb8aa8afe2" }, "description": "The IDs of the feeds to return (send comma-separated list of feed IDs without spaces)" }, { "name": "exemptFeedIds", "in": "query", "required": false, "schema": { "type": "string", "example": "97576a5d-4362-40cb-b8ac-5418b64bf84f,6d54cb3d-da29-461b-8019-3dfb8aa8afe2" }, "description": "The IDs of the feeds to exempt from the search (send comma-separated list of feed IDs without spaces)" }, { "name": "isSearchForMarkDuplicate", "in": "query", "required": false, "schema": { "type": "boolean", "example": false }, "description": "Whether to search for mark duplicate feeds(questions)" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "result": { "type": "object", "properties": { "nextPageToken": { "type": "integer", "example": 1759911721822 }, "size": { "type": "integer", "example": 10 }, "total": { "type": "integer", "example": 11 }, "listOfItems": { "type": "array", "items": { "$ref": "#/paths/~1b2b~1rfeed~1feeds~1{feedId}/get/responses/200/content/application~1json/schema/properties/result" } }, "sortBy": { "type": "string", "example": "lastActivityAt" } } } } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Failed to get feeds" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_INPUT" }, "message": { "type": "string", "example": "An error occurred while processing the request" }, "cause": { "type": "string", "example": "size is required" } } } } } } } } }, "401": { "description": "Authorize error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Missing/Invalid authentication token" } } } } } }, "403": { "description": "Forbidden error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_code": { "type": "integer", "example": 2001 }, "message": { "type": "string", "example": "Something went wrong, please try again" } } } } } } } } } }, "components": { "securitySchemes": { "OAuth2ClientCredentials": { "type": "oauth2", "description": "This API uses OAuth 2 with the implicit grant flow.", "flows": { "clientCredentials": { "tokenUrl": "https://platform.{env}.simpplr.xyz/v1/identity/oauth/token", "scopes": {} } } } } }, "security": [ { "OAuth2ClientCredentials": [] } ] } ```