{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/workers/:id/deactivate","auth":"required","settings":"","results":{"codes":[{"status":200,"name":"","code":"{\n  \"is_active\": false,\n  \"name\": \"Leonard Jones\",\n  \"email\": \"worker:::at:::example.com\",\n  \"id\": \"93e8c969-4d0b-4a98-8119-008e50286e65\",\n  \"approved_at\": \"2018-03-15T16:12:28.648-07:00\",\n  \"data_collection_checks\": []\n}","language":"json"}]},"method":"post","examples":{"codes":[{"language":"curl","code":"curl -X POST -H 'Content-Type: application/json' -H 'X-ACCESS-TOKEN: secret-api-token' -d '{\"is_active\":false}' 'https://api.fountain.com/v2/workers/01234567-0000-0000-0000-000000000000/deactivate'\n\n"}]},"params":[{"name":"id","type":"string","default":"550e8400-e29b-41d4-a716-446655440000","desc":"ID must be included in the URL","required":false,"in":"path","ref":"","_id":"579be22b5623be2200832673"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"60dd18add0f152004868b578"}]},"next":{"description":"","pages":[]},"title":"Deactivate Worker","type":"endpoint","slug":"deactivate-worker","excerpt":"","body":"Updates workers'  `is_active` attribute to `false` and marks worker as \"Deactivated\" in Posthire. Cancels all active recurring checks and follow-up messages for this applicant. \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: \\\"[email protected]\\\"\",\n      \"language\": \"markdown\"\n    }\n  ]\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d898fca72fe5100110d06ff","project":"59de6011debd1200240f68ec","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Posthire Worker Management","slug":"worker-management","order":9,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68fe","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"createdAt":"2016-07-29T17:56:09.833Z"},"user":"547504ed59fade080004cb8b","createdAt":"2019-09-24T03:38:50.796Z","__v":10,"parentDoc":null}