{"_id":"59de6011debd1200240f693a","parentDoc":null,"user":"547504ed59fade080004cb8b","__v":9,"category":{"_id":"59de6011debd1200240f68fe","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-29T17:56:09.833Z","from_sync":false,"order":9,"slug":"worker-management","title":"Worker Management"},"version":{"_id":"59de6011debd1200240f68ee","__v":2,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z","categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"project":"59de6011debd1200240f68ec","githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-29T23:09:31.149Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X PUT -H 'Content-Type: application/json' -d '{\"is_active\":true,\"api_token\":\"secret-api-token\"}' 'https://api.fountain.com/v2/workers/01234567-0000-0000-0000-000000000000'\n\n","language":"curl"}]},"method":"put","results":{"codes":[{"language":"json","code":"{\n  \"is_active\": true,\n  \"name\": \"Leonard Jones\",\n  \"email\": \"halle:::at:::hudson.biz\",\n  \"id\": \"93e8c969-4d0b-4a98-8119-008e50286e65\",\n  \"approved_at\": \"2018-03-15T16:12:28.648-07:00\",\n  \"data_collection_checks\": []\n}","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"579be22b5623be2200832673","ref":"","in":"path","required":false,"desc":"ID must be included in the URL","default":"550e8400-e29b-41d4-a716-446655440000","type":"string","name":"id"},{"_id":"579be22b5623be2200832672","ref":"","in":"query","required":false,"desc":"Required if api_token is not passed in header","default":"secret-api-token","type":"string","name":"api_token"}],"url":"/workers/:id"},"isReference":false,"order":2,"body":"At the moment you can only update the `is_active` attribute.\n\n## Response Schema\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"*   [id]\\n    \\n    *   Required: no\\n    *   Type: string\\n    *   Example: \\\"01234567-0000-0000-0000-000000000000\\\"\\n    \\n*   [approved_at]\\n    \\n    *   Required: no\\n    *   Type: string\\n    *   Format: date-time\\n    *   Example: \\\"2016-06-29T04:01:13.000-07:00\\\"\\n    \\n*   [is_active]\\n    \\n    *   Required: no\\n    *   Type: boolean\\n    *   Example: false\\n    \\n*   [name]\\n    \\n    *   Required: no\\n    *   Type: string\\n    *   Example: \\\"Rosemary Durgan\\\"\\n    \\n*   [email]\\n    \\n    *   Required: no\\n    *   Type: string\\n    *   Example: \\\"billy.kiehn@reillyjerde.net\\\"\",\n      \"language\": \"markdown\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"update-worker-info","type":"endpoint","title":"Update Worker Info"}

putUpdate Worker Info


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string550e8400-e29b-41d4-a716-446655440000
ID must be included in the URL

Query Params

api_token:
stringsecret-api-token
Required if api_token is not passed in header

Examples


Result Format


Documentation

At the moment you can only update the `is_active` attribute. ## Response Schema [block:code] { "codes": [ { "code": "* [id]\n \n * Required: no\n * Type: string\n * Example: \"01234567-0000-0000-0000-000000000000\"\n \n* [approved_at]\n \n * Required: no\n * Type: string\n * Format: date-time\n * Example: \"2016-06-29T04:01:13.000-07:00\"\n \n* [is_active]\n \n * Required: no\n * Type: boolean\n * Example: false\n \n* [name]\n \n * Required: no\n * Type: string\n * Example: \"Rosemary Durgan\"\n \n* [email]\n \n * Required: no\n * Type: string\n * Example: \"billy.kiehn@reillyjerde.net\"", "language": "markdown" } ] } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}