{"docs":{"name":"Qulture.Rocks","info":"\n\u003cp\u003e# Qulture.rocks integration API\u003c/p\u003e\n\n\u003cp\u003eBase URL for production environment: \u003ca href=\"https://app.qulture.rocks\"\u003eapp.qulture.rocks\u003c/a\u003e\u003c/p\u003e\n\n\u003cp\u003eThe only accepted format is json.\u003c/p\u003e\n\n\u003cp\u003eAll requests will be authenticated by an API token sent on the header.\u003c/p\u003e\n\n\u003cp\u003eTo get the credential token, login as an administrator in Qulture.Rocks platform, and go to Organization → Integrations → API Platform → Regenerate and copy the token.\u003c/p\u003e\n\n\u003cp\u003eNote that you must use the User API token (not the platform API token).\u003c/p\u003e\n\n\u003cp\u003eThe header format must be: “Authorization: Token token=\u0026lt;\u0026lt;token\u0026gt;\u0026gt;”, i.e “Authorization: Token token=Mm6mTGtFjvRUBrkaPGtswq7H”.\u003c/p\u003e\n\n\u003cp\u003ePlease read carefully the documentation for each endpoint before reporting problems. A very common problem is answered at POST user_importer.\u003c/p\u003e\n","copyright":null,"doc_url":"/apidoc/1.0","api_url":"","resources":{"contracts":{"doc_url":"/apidoc/1.0/contracts","id":"contracts","api_url":"","name":"Contracts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/contracts/index","name":"index","apis":[{"api_url":"/(/:locale)/api_integration/contracts","http_method":"GET","short_description":"List contracts","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a paginated list of all contracts of your company. Each contract has its user. Within the headers you may find the Total number of contracts (Total). To access the profile picture, use the contract.user.profile_picture_cloudinary_id as follows:\u003c/p\u003e\n\n\u003cpre class=\"ruby\"\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;https://res.cloudinary.com/qulture/image/upload/{{contract.user.profile_picture_cloudinary_id}}.png\u0026quot;\u003c/span\u003e\n\u003c/pre\u003e\n\n\u003cp\u003eWhich should result in:\u003c/p\u003e\n\n\u003cpre class=\"ruby\"\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;https://res.cloudinary.com/qulture/image/upload/eyrkci3nmanvh7oubebq.png\u0026quot;\u003c/span\u003e\n\u003c/pre\u003e\n\n\u003ch2 id=\"label-Headers\"\u003eHeaders\u003cspan\u003e\u003ca href=\"#label-Headers\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cpre\u003eTotal: The total amount of contracts\u003c/pre\u003e\n","errors":[],"params":[{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many items per page. Default: 10. Max: 50.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number. Default: 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch by name or nickname\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"active","full_name":"active","description":"\n\u003cp\u003eActive contracts. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inactive","full_name":"inactive","description":"\n\u003cp\u003eInactive contracts. Default: false. If you want to fetch inactive contracts only, set active to false as well.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_email","full_name":"with_email","description":"\n\u003cp\u003eSearch by email\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_email_or_cpf","full_name":"with_email_or_cpf","description":"\n\u003cp\u003eSearch by email or CPF\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"with_username","full_name":"with_username","description":"\n\u003cp\u003eSearch by username\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_by_nickname_or_name","full_name":"order_by_nickname_or_name","description":"\n\u003cp\u003eOrder name or nickname. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["{\n  contracts: [\n    {\n        active: true,\n        admission_date: '2015-11-01',\n        area: 'North',\n        birth_date: '1990-01-30',\n        company_id: 72,\n        country: 'Westeros',\n        cpf: '30312345689',\n        created_at: '2016-10-03T20:14:43.678-03:00',\n        department: 'Ice',\n        education: 'N/A',\n        email: 'john@snow.got',\n        id: 5828,\n        job_title: 'King in the North',\n        last_career_move_date: '2016-01-30',\n        last_invitation_sent_at: '2016-10-06T11:12:33.417-03:00',\n        level: 'Reborn',\n        location: 'Westeros',\n        name: 'John Snow',\n        nickname: 'Knows nothing',\n        objectives_average_by_cycle: {12: 88},\n        rg: '123456789',\n        role: 'member',\n        salary_rage: 'R$1000 a R$2000',\n        sex: 'male',\n        supervisor_id: 5822,\n        termination_date: null,\n        termination_reason: null,\n        user: {\n            id: 5465,\n            name: 'John Snow',\n            email: 'john@snow.got',\n            profile_picture_cloudinary_id: 'eyrkci3nmanvh7oubebq',\n            preferred_language: 'pt',\n            created_at: '2016-10-03T20:14:43.676-03:00',\n            sign_in_count: 1\n        }\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"user_importer_items":{"doc_url":"/apidoc/1.0/user_importer_items","id":"user_importer_items","api_url":"","name":"User_importer_items","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/user_importer_items/index","name":"index","apis":[{"api_url":"/(/:locale)/api_integration/user_importers/:user_importer_id/user_importer_items","http_method":"GET","short_description":"List user_importer_items for a given user_importer","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"with_errors","full_name":"with_errors","description":"\n\u003cp\u003eOnly items with errors\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["  {\n    \"user_importer_items\": [\n      {\n        \"id\": 1234,\n        \"user_importer_id\": 1,\n        \"company_id\": 1,\n        \"data\": {\n          \"name\": \"João Batista\",\n          \"tags\": [\n              \"[Nível] - JR\",\n              \"[País] - BRASIL\"\n          ],\n          \"email\": \"joao.b@.com\",\n          \"active\": \"true\",\n          \"supervisor_email\": \"lili@dunder\"\n        },\n        \"import_errors\": [\n          [\n            \"supervisor_email\",\n            \"invalid_email\"\n          ]\n        ],\n        \"state\": \"done\",\n        \"uid\": 214\n      }\n    ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"user_importers":{"doc_url":"/apidoc/1.0/user_importers","id":"user_importers","api_url":"","name":"User_importers","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/user_importers/index","name":"index","apis":[{"api_url":"/(/:locale)/api_integration/user_importers","http_method":"GET","short_description":"List user_importers","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eList user_importers\u003c/p\u003e\n","errors":[],"params":[{"name":"include","full_name":"include","description":"\n\u003cp\u003eOptional data to be included in the response. Values must be separated by comma.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eprogress\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["{\n  \"user_importers\": [\n    {\n      \"id\": 61,\n      \"company_id\": 1,\n      \"state\": \"done\",\n      \"user_importer_data_id\": 61,\n      \"created_at\": \"2018-04-16T17:31:35.019-03:00\",\n      \"import_errors\": [],\n      \"progress\": \"100.0%\"\n    },\n    {\n      \"id\": 62,\n      \"company_id\": 1,\n      \"state\": \"done\",\n      \"user_importer_data_id\": 62,\n      \"created_at\": \"2018-04-16T17:35:27.993-03:00\",\n      \"import_errors\": [],\n      \"progress\": \"100.0%\"\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/1.0/user_importers/show","name":"show","apis":[{"api_url":"/(/:locale)/api_integration/user_importers/:id","http_method":"GET","short_description":"Show a user_importer","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eShow user_importer\u003c/p\u003e\n","errors":[],"params":[{"name":"include","full_name":"include","description":"\n\u003cp\u003eOptional data to be included in the response. Values must be separated by comma.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eprogress\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["{\n  \"user_importer\": {\n    \"id\": 61,\n    \"company_id\": 1,\n    \"state\": \"done\",\n    \"user_importer_data_id\": 61,\n    \"created_at\": \"2018-04-16T17:31:35.019-03:00\",\n    \"import_errors\": [],\n    \"progress\": \"100.0%\"\n  }\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/1.0/user_importers/create","name":"create","apis":[{"api_url":"/(/:locale)/api_integration/user_importers","http_method":"POST","short_description":"Create a UserImporter, that will manage the creation or update of the users you pass as data.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreates or updates multiple users based on the received data.\u003c/p\u003e\n\n\u003cp\u003eThe provided tags will be added to existing users.\u003c/p\u003e\n\n\u003cp\u003eAttention: The importing process will enqueue an async job that might take some minutes to get executed. You may check the import progress by including `include=progress` in the request params.\u003c/p\u003e\n\n\u003cp\u003eYou can add 1500 user records per user importer.\u003c/p\u003e\n\n\u003cp\u003e\u0026gt; A very common error is to get the response after making this POST request and think that the user is created instantly.\u003c/p\u003e\n\n\u003cp\u003eThe users will only be imported when the user_importer.state = \u0026#39;done\u0026#39;\u003c/p\u003e\n\n\u003cp\u003eYou may check errors on user_importer.import_errors and calling user_importer_items endpoint with the param with_errors=true\u003c/p\u003e\n\n\u003ch2 id=\"label-Finding+a+user\"\u003eFinding a user\u003cspan\u003e\u003ca href=\"#label-Finding+a+user\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cp\u003eBy default, the importer finds a given user by email. If you want to find a user by CPF or username, you should send the field user_login\u003c/p\u003e\n\n\u003cp\u003eNote that, if you send CPF and email without user_login (which defaults to email), the importer will find or create the user with the email, and it will update the CPF. If you send user_login = \u0026#39;cpf\u0026#39;, the importer will find or create the user with the CPF, and it will update the field email and username. If you send user_login = \u0026#39;username\u0026#39;, the importer will find or create the user with the username, and it will update the field email and CPF.\u003c/p\u003e\n\n\u003cp\u003eA common mistake it to send cpf: “xxxxxxxxx”, email: “” without sending user_login. You may get the error that the that CPF is already being used for another user. In that case, user user_login: “cpf” and don\u0026#39;t send the email field.\u003c/p\u003e\n\n\u003ch2 id=\"label-Inactivating+contracts\"\u003eInactivating contracts\u003cspan\u003e\u003ca href=\"#label-Inactivating+contracts\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cp\u003eThe consequences of inactivating a contract are:\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eUsers can\u0026#39;t interact with it. For instance: sending feedback, answering a review, answering a 1:1, etc.\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eUsers can, though, see data from past interactions, such as received feedbacks or reviews.\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n\n\u003ch3 id=\"label-Triggered+system+actions-3A\"\u003eTriggered system actions:\u003cspan\u003e\u003ca href=\"#label-Triggered+system+actions-3A\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h3\u003e\n\u003col\u003e\u003cli\u003e\n\u003cp\u003eContract is removed from shared objectives\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eFeedback requests sent by contract are inactivated\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eContract is removed from all teams\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eContract is removed as supervisor of other contracts\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ePulse survey participations are inactivated\u003c/p\u003e\n\u003c/li\u003e\u003c/ol\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eNote that none of those actions will be reversed if you reactivate the contract.\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n\n\u003cp\u003e***\u003c/p\u003e\n\n\u003ch2 id=\"label-Custom+Fields\"\u003eCustom Fields\u003cspan\u003e\u003ca href=\"#label-Custom+Fields\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cp\u003eIf you need to sync custom attributes, like “t-shirt size”, you may use Custom Contract Fields.\u003c/p\u003e\n\n\u003cp\u003eIf you need to get them programmatically, follow the steps on this article to get each field key: \u003ca href=\"https://help.qulture.rocks/pt-BR/articles/4075294-api-da-plataforma-beta\"\u003ehelp.qulture.rocks/pt-BR/articles/4075294-api-da-plataforma-beta\u003c/a\u003e\u003c/p\u003e\n\n\u003cp\u003eOtherwise, you may access the Platform as a company editor (or ask HR) -\u0026gt; Company profile -\u0026gt; User Importers, and click on “Export Template”. That spreadsheet has all the available fields. For the custom fields, just copy the key in the header.\u003c/p\u003e\n\n\u003cp\u003eAfter that, you may send the key\u0026#39;s value as you key.\u003c/p\u003e\n\n\u003cp\u003eE.G. for the following ContractField:\u003c/p\u003e\n\n\u003cp\u003e“contractField”: {\u003c/p\u003e\n\n\u003cpre\u003e\u0026quot;name\u0026quot;: \u0026quot;T-Shirt size\u0026quot;,\n\u0026quot;key\u0026quot;: \u0026quot;add55b58-3640-4ad8-aba2-b118b6e6472c\u0026quot;\u003c/pre\u003e\n\n\u003cp\u003e}\u003c/p\u003e\n\n\u003cp\u003eyou may add to your post payload:\u003c/p\u003e\n\n\u003cp\u003e“data”: [\u003c/p\u003e\n\n\u003cpre class=\"ruby\"\u003e{\n  \u003cspan class=\"ruby-value\"\u003e\u0026quot;name\u0026quot;:\u003c/span\u003e \u003cspan class=\"ruby-string\"\u003e\u0026quot;joao\u0026quot;\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003e\u0026quot;active\u0026quot;:\u003c/span\u003e \u003cspan class=\"ruby-keyword\"\u003etrue\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003e\u0026quot;email\u0026quot;:\u003c/span\u003e \u003cspan class=\"ruby-string\"\u003e\u0026quot;joao@example.com.br\u0026quot;\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003e\u0026quot;add55b58-3640-4ad8-aba2-b118b6e6472c\u0026quot;:\u003c/span\u003e \u003cspan class=\"ruby-string\"\u003e\u0026quot;SMALL\u0026quot;\u003c/span\u003e\n}\n\u003c/pre\u003e\n\n\u003ch2 id=\"label-Best+practices\"\u003eBest practices\u003cspan\u003e\u003ca href=\"#label-Best+practices\"\u003e\u0026para;\u003c/a\u003e \u003ca href=\"#top\"\u003e\u0026uarr;\u003c/a\u003e\u003c/span\u003e\u003c/h2\u003e\n\n\u003cp\u003eThis importer was built to receive many users at a time, so we recommend sending all your users in one importer. By doing so, you only need to control one enpoint and wait it to be finished in order to check for errors.\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized - Returned when token is invalid","metadata":{"error":"You are not authorized to perform this action"}},{"code":400,"description":"Bad Request - Returned when data format is invalid ","metadata":{"status":"400","error":"Bad Request"}}],"params":[{"name":"user_importer","full_name":"user_importer","description":"\n\u003cp\u003eImporter JSON object\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"send_invite_mails","full_name":"user_importer[send_invite_mails]","description":"\n\u003cp\u003eSends invitations to all the active users created on the import.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"user_importer[data]","description":"\n\u003cp\u003eArray of users to be imported\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"user_importer[data][name]","description":"\n\u003cp\u003eUser name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"active","full_name":"user_importer[data][active]","description":"\n\u003cp\u003eBoolean indicating if the user is active\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"default_contract_for_user","full_name":"user_importer[data][default_contract_for_user]","description":"\n\u003cp\u003eBoolean indicating if the contract is default_contract_for_user, i.e., if this company should be the default to be opened at login for this user (only needed if user has more than one company)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked","full_name":"user_importer[data][blocked]","description":"\n\u003cp\u003eBoolean indicating if the contract is blocked, i.e. can not login nor receive emails but still appears in the platform as active\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"user_importer[data][email]","description":"\n\u003cp\u003eUser email (unique user identifier).\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eMust be unique;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eMust match regular expression \u003ccode\u003e(?i-mx:\\A([^@\\s]+)@((?:[-a-z0-9]\\.)[a-z]{2,})\\z)\u003c/code\u003e;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eMust not be in use in other company;\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"supervisor_email","full_name":"user_importer[data][supervisor_email]","description":"\n\u003cp\u003eUser supervisor email.\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eThe supervisor email cannot be the same as the user email;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eMust match regular expression \u003ccode\u003e(?i-mx:\\A([^@\\s]+)@((?:[-a-z0-9]\\.)[a-z]{2,})\\z)\u003c/code\u003e;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eThe supervisor can\u0026#39;t be bellow user in company\u0026#39;s hierarchy;\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"user_importer[data][tags]","description":"\n\u003cp\u003eArray of strings representing in what tags the user is included\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags_admin_only","full_name":"user_importer[data][tags_admin_only]","description":"\n\u003cp\u003eArray of strings representing in what tags that are only visible for admins the user is included\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"supervisor_cpf","full_name":"user_importer[data][supervisor_cpf]","description":"\n\u003cp\u003eSupervisor CPF (Use either supervisor_email or CPF to find a contract and assign it as the current user\u0026#39;s supervisor).\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eOnly digits are accepted;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eMust be a valid CPF number;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eThe supervisor CPF cannot be the same as the user CPF;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eThe supervisor can\u0026#39;t be bellow user in company\u0026#39;s hierarchy;\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number or string.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"area","full_name":"user_importer[data][area]","description":"\n\u003cp\u003eArea\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location","full_name":"user_importer[data][location]","description":"\n\u003cp\u003eLocation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"level","full_name":"user_importer[data][level]","description":"\n\u003cp\u003eLevel\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rg","full_name":"user_importer[data][rg]","description":"\n\u003cp\u003eRG\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cpf","full_name":"user_importer[data][cpf]","description":"\n\u003cp\u003eUser CPF may be used as unique identifier, instead of email OR username.\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eMust be unique;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eOnly digits are accepted;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eMust be a valid CPF number;\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number or string.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cpf_password_prefix","full_name":"user_importer[data][cpf_password_prefix]","description":"\n\u003cp\u003ePassword prefix for users. When provided, the system will generate a password using this prefix combined with the first 6 digits of the user\u0026#39;s CPF.\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eRequires CPF to be present;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eGenerated password format: {prefix}{first_6_cpf_digits}#A1\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_update_password","full_name":"user_importer[data][force_update_password]","description":"\n\u003cp\u003eForce update password. When provided, the system will update the password of the user with cpf_password_prefix even if it already exists.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"user_importer[data][username]","description":"\n\u003cp\u003eUser username may be used as unique identifier, instead of email or CPF.\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eMust be unique;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eOnly digits and letters are accepted;\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"identifier","full_name":"user_importer[data][identifier]","description":"\n\u003cp\u003eCustom User identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_uid","full_name":"user_importer[data][external_uid]","description":"\n\u003cp\u003eIf company setting enable_external_uid is active, you may use this field as the login identifier for SSO, in addition to email\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country","full_name":"user_importer[data][country]","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"education","full_name":"user_importer[data][education]","description":"\n\u003cp\u003eEducation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"department","full_name":"user_importer[data][department]","description":"\n\u003cp\u003eDepartment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_title","full_name":"user_importer[data][job_title]","description":"\n\u003cp\u003eJob Title\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"nickname","full_name":"user_importer[data][nickname]","description":"\n\u003cp\u003eNickname\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sex","full_name":"user_importer[data][sex]","description":"\n\u003cp\u003eUser\u0026#39;s sex\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003efemale\u003c/code\u003e, \u003ccode\u003emale\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"gender","full_name":"user_importer[data][gender]","description":"\n\u003cp\u003eUser\u0026#39;s gender\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecis_woman\u003c/code\u003e, \u003ccode\u003ecis_man\u003c/code\u003e, \u003ccode\u003etrans_woman\u003c/code\u003e, \u003ccode\u003etrans_man\u003c/code\u003e, \u003ccode\u003etravestite\u003c/code\u003e, \u003ccode\u003enon_binary\u003c/code\u003e, \u003ccode\u003eagender\u003c/code\u003e, \u003ccode\u003erather_not_answer\u003c/code\u003e, \u003ccode\u003enone_of_the_others\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_login","full_name":"user_importer[data][user_login]","description":"\n\u003cp\u003eEmail is the default user identifier. You may use cpf or username if you need to import users that don\u0026#39;t have email or CPF, or for changing users\u0026#39; emails.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eemail\u003c/code\u003e, \u003ccode\u003ecpf\u003c/code\u003e, \u003ccode\u003eusername\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"preferred_language","full_name":"user_importer[data][preferred_language]","description":"\n\u003cp\u003eUser\u0026#39;s default language\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"termination_reason","full_name":"user_importer[data][termination_reason]","description":"\n\u003cp\u003eTermination reason\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003evoluntary\u003c/code\u003e, \u003ccode\u003einvoluntary\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"termination_cause","full_name":"user_importer[data][termination_cause]","description":"\n\u003cp\u003eTermination cause.\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eTermination Reason is required;\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eWith \u003cstrong\u003etermination_reason\u003c/strong\u003e as \u003ccode\u003einvoluntary\u003c/code\u003e:\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eMust be one of: \u003ccode\u003elow_performance\u003c/code\u003e,\u003ccode\u003eproject_time\u003c/code\u003e,\u003ccode\u003estaff_reduction\u003c/code\u003e,\u003ccode\u003eincompatible_culture_and_values\u003c/code\u003e,\u003ccode\u003ebehavioural_problems\u003c/code\u003e,\u003ccode\u003epolicy_violation\u003c/code\u003e,\u003ccode\u003eillegal_behavior\u003c/code\u003e,\u003ccode\u003einsubordination\u003c/code\u003e,\u003ccode\u003einformation_security_problems\u003c/code\u003e,\u003ccode\u003edamage_to_property\u003c/code\u003e,\u003ccode\u003econtract_expiration\u003c/code\u003e;\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eWith \u003cstrong\u003etermination_reason\u003c/strong\u003e as \u003ccode\u003evoluntary\u003c/code\u003e\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eMust be one of: \u003ccode\u003ecareer_opportunity\u003c/code\u003e,\u003ccode\u003echange_of_career\u003c/code\u003e,\u003ccode\u003eremuneration\u003c/code\u003e,\u003ccode\u003eleadership\u003c/code\u003e,\u003ccode\u003eteam_relationship\u003c/code\u003e,\u003ccode\u003ebenefits\u003c/code\u003e,\u003ccode\u003eculture_and_values\u003c/code\u003e,\u003ccode\u003eorganizational_climate\u003c/code\u003e,\u003ccode\u003ediversity_and_inclusion\u003c/code\u003e,\u003ccode\u003epersonal_motives\u003c/code\u003e,\u003ccode\u003eworkload\u003c/code\u003e;\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecareer_opportunity\u003c/code\u003e, \u003ccode\u003echange_of_career\u003c/code\u003e, \u003ccode\u003eremuneration\u003c/code\u003e, \u003ccode\u003eleadership\u003c/code\u003e, \u003ccode\u003eteam_relationship\u003c/code\u003e, \u003ccode\u003ebenefits\u003c/code\u003e, \u003ccode\u003eculture_and_values\u003c/code\u003e, \u003ccode\u003eorganizational_climate\u003c/code\u003e, \u003ccode\u003ediversity_and_inclusion\u003c/code\u003e, \u003ccode\u003epersonal_motives\u003c/code\u003e, \u003ccode\u003eworkload\u003c/code\u003e, \u003ccode\u003elow_performance\u003c/code\u003e, \u003ccode\u003eproject_time\u003c/code\u003e, \u003ccode\u003estaff_reduction\u003c/code\u003e, \u003ccode\u003eincompatible_culture_and_values\u003c/code\u003e, \u003ccode\u003ebehavioural_problems\u003c/code\u003e, \u003ccode\u003epolicy_violation\u003c/code\u003e, \u003ccode\u003eillegal_behavior\u003c/code\u003e, \u003ccode\u003einsubordination\u003c/code\u003e, \u003ccode\u003einformation_security_problems\u003c/code\u003e, \u003ccode\u003edamage_to_property\u003c/code\u003e, \u003ccode\u003econtract_expiration\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"birth_date","full_name":"user_importer[data][birth_date]","description":"\n\u003cp\u003eBirth date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must match regular expression \u003ccode\u003e/\\d{4}-\\d{2}-\\d{2}/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"termination_date","full_name":"user_importer[data][termination_date]","description":"\n\u003cp\u003eTermination date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must match regular expression \u003ccode\u003e/\\d{4}-\\d{2}-\\d{2}/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"admission_date","full_name":"user_importer[data][admission_date]","description":"\n\u003cp\u003eAdmission date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must match regular expression \u003ccode\u003e/\\d{4}-\\d{2}-\\d{2}/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_career_move_date","full_name":"user_importer[data][last_career_move_date]","description":"\n\u003cp\u003eLast caree move date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must match regular expression \u003ccode\u003e/\\d{4}-\\d{2}-\\d{2}/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_supervisor","full_name":"user_importer[data][remove_supervisor]","description":"\n\u003cp\u003eWarning: this is a destructive param. You you are not sure, please avoid using it. By setting this to true, the system will remove the supervisor from the contract.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"destroy_taggings","full_name":"user_importer[data][destroy_taggings]","description":"\n\u003cp\u003eWarning: this is a destructive param. You you are not sure, please avoid using it. By setting this to true, the system will remove all tags from user. That may alter the visibility of questions for ongoing reviews, for instance.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"destroy_taggings_ignore_tags","full_name":"user_importer[data][destroy_taggings_ignore_tags]","description":"\n\u003cp\u003eArray of strings representing which tags should be ignored by the “destroy_taggings” option. Cannot be used with :destroy_taggins_restrict_tags option.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"destroy_taggings_restrict_tags","full_name":"user_importer[data][destroy_taggings_restrict_tags]","description":"\n\u003cp\u003eArray of strings representing which tags should be considered by the “destroy_taggings” option. Cannout be used with the :destroy_taggins_ignore_tags option.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"one_on_one_segment_member","full_name":"user_importer[data][one_on_one_segment_member]","description":"\n\u003cp\u003eBoolean indicating whether a contract should be added in the 1:1 access segment or if should be removed. If set to true, the contract will be added to the segment. If set to false, the contract will be removed from the segment.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eOptional data to be included in the response. Values must be separated by comma.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eprogress\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["Request\n\n{\n  \"user_importer\": {\n    \"send_invite_mails\": true,\n    \"data\": [\n      {\n        \"name\": \"joao\",\n        \"active\": true,\n        \"email\": \"joao@example.com.br\",\n        \"tags\": [\"consultor\"],\n        \"supervisor_email\": \"davi@example.com.br\",\n        \"supervisor_cpf\": \"30312345689\",\n        \"area\": \"North\",\n        \"location\": \"Westeros\",\n        \"level\": \"Reborn\",\n        \"rg\": \"123456789\",\n        \"cpf\": \"43000086390\",\n        \"country\": \"Westeros\",\n        \"education\": \"N/A\",\n        \"department\": \"Ice\",\n        \"job_title\": \"King in the North\",\n        \"nickname\": \"Knows nothing\",\n        \"sex\": \"male\",\n        \"gender\": \"cis_man\",\n        \"remove_supervisor\": false,\n        \"termination_reason\": null,\n        \"termination_cause\": null,\n        \"birth_date\": \"1990-01-30\",\n        \"termination_date\": null,\n        \"admission_date\": \"2015-11-01\",\n        \"last_career_move_date\": \"2016-01-30\"\n      },\n      {\n        \"name\": \"davi\",\n        \"active\": true,\n        \"email\": \"davi@example.com.br\",\n        \"tags\": [\"consultor\", \"gerente\"]\n      }\n    ]\n  }\n}\n\nResponse\n\nStatus: 201 Created\n\n{\n  \"user_importer\": {\n      \"id\": 17,\n      \"company_id\": 1,\n      \"state\": \"enqueued\",\n      \"user_importer_data_id\": 17,\n      \"created_at\": \"2018-03-15T20:30:13.354-03:00\"\n  }\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}}}}