{"_id":"59de6011debd1200240f6937","__v":1,"category":{"_id":"59de6011debd1200240f68fc","__v":0,"version":"59de6011debd1200240f68ee","project":"59de6011debd1200240f68ec","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-22T04:45:31.980Z","from_sync":false,"order":3,"slug":"label-management-endpoints","title":"Label Management"},"parentDoc":null,"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","user":"547504ed59fade080004cb8b","githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-22T05:25:28.856Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X PUT -H 'Content-Type: application/json' -d '{\"completed\":true,\"api_token\":\"secret-api-token\"}' 'https://api.fountain.com/v2/applicants/22222222-0000-0000-0000-000000000000/labels/Label%201'"},{"code":" https://onboardiq.com/api/v2/applicants/22222222-0000-0000-0000-000000000000/labels/Label%201?completed=true","language":"text"}]},"method":"put","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"labels\": [\n    {\n      \"title\": \"Label 1\",\n      \"completed\": true\n    }\n  ]\n}","name":""},{"status":401,"language":"json","code":"{\n  \"message\": \"Authentication is required\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56ca9bc85439cb0b00117974","ref":"","in":"path","required":false,"desc":"must be included in the URL","default":"22222222-0000-0000-0000-000000000000","type":"string","name":"applicant_id"},{"_id":"56ca9bc85439cb0b00117973","ref":"","in":"path","required":false,"desc":"must be included in the URL","default":"","type":"string","name":"title"},{"_id":"5769a56cf480fb0e004dc0ab","ref":"","in":"body","required":false,"desc":"payload","default":"true","type":"string","name":"completed"},{"_id":"56ca9bc85439cb0b00117972","ref":"","in":"body","required":false,"desc":"Required if api-token not included in header","default":"secret-api-token","type":"string","name":"api_token"},{"_id":"588b7c916aca6f2500d115ec","ref":"","in":"body","required":false,"desc":"Manually set the date that this label became true","default":"","type":"yyyy-mm-dd","name":"completed_at"}],"url":"/applicants/:applicant_id/labels/:title"},"isReference":false,"order":1,"body":"This method updates a list of labels for an applicant. Use it to delete existing labels for an applicant or add new ones.\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"NOTE: Remember URL Encoding!\",\n  \"body\": \"The label names that you use must be URLencoded, e.g. 'New%20label' and not 'New label'.\"\n}\n[/block]\n## Response Schema\n[block:html]\n{\n  \"html\": \"<ul><li>additionalProperties: false</li><li>    <span id=\\\"title-0-1373277398612929976\\\">\\n      <a href=\\\"#title-0-1373277398612929976\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"Label 1\\\"</tt></li></ul></div></li><li>    <span id=\\\"completed-0-2397351418956293556\\\">\\n      <a href=\\\"#completed-0-2397351418956293556\\\" class=\\\"anchor\\\">\\n        <tt>completed</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: boolean</li><li>Example: <tt>true</tt></li></ul></div></li></ul>\"\n}\n[/block]","excerpt":"","slug":"update-label-for-applicant","type":"endpoint","title":"Update Label for Applicant"}

putUpdate Label for Applicant


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

applicant_id:
string22222222-0000-0000-0000-000000000000
must be included in the URL
title:
string
must be included in the URL

Body Params

completed:
stringtrue
payload
api_token:
stringsecret-api-token
Required if api-token not included in header
completed_at:
yyyy-mm-dd
Manually set the date that this label became true

Examples


Result Format


Documentation

This method updates a list of labels for an applicant. Use it to delete existing labels for an applicant or add new ones. [block:callout] { "type": "warning", "title": "NOTE: Remember URL Encoding!", "body": "The label names that you use must be URLencoded, e.g. 'New%20label' and not 'New label'." } [/block] ## Response Schema [block:html] { "html": "<ul><li>additionalProperties: false</li><li> <span id=\"title-0-1373277398612929976\">\n <a href=\"#title-0-1373277398612929976\" class=\"anchor\">\n <tt>title</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"Label 1\"</tt></li></ul></div></li><li> <span id=\"completed-0-2397351418956293556\">\n <a href=\"#completed-0-2397351418956293556\" class=\"anchor\">\n <tt>completed</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: boolean</li><li>Example: <tt>true</tt></li></ul></div></li></ul>" } [/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 }}