List Attributes
Adding attributes to candidates, companies, contact persons and projects requires an attributeId
. To obtain these attribute ID’s you first have to do a GET request for the selected attribute scope, using this request.
URL | https://api.recman.no/v2/get/ |
Project Attribute Scope | projectAttribute |
Candidate Attribute Scope | candidateAttribute |
Company Attribute Scope | companyAttribute |
Company Contact Attribute Scope | companyContactAttribute |
Example | https://api.recman.no/v2/get/?key=YOUR_KEY&scope=companyAttribute |
Example
Here is an example of the response you will get doing a GET request for the companyAttribute
scope.
json
{
"success": true,
"numRows": 2,
"data": {
"378": {
"attributeId": "378",
"name": "Company Turnover",
"bool": 0,
"rating": 0,
"text": 1
},
"383": {
"attributeId": "383",
"name": "Customer Group",
"bool": 0,
"rating": 0,
"text": 0,
"dropdownList": [
{
"dropdownId": "488",
"name": "Retail and Wholesale"
},
{
"dropdownId": "489",
"name": "Platinum, Gold and Silver"
},
{
"dropdownId": "490",
"name": "Special member"
}
]
}
}
}
Click here if you want to try out our API tester
Adding attributes to different scopes
To add attributes to, for instance, companies, you will have to visit the company reference page for more details.
Just to give you a quick look. Here’s how you add the attribute “Customer Group” with the drop-down value “Special member” from the example above to a company.
json
{
"key": "YOUR_KEY",
"scope": "company",
"operation": "insert",
"data": {
"companyId": 1209220,
"attribute": {
"attributeId": 383,
"dropdownId": 490
}
}
}