Company Provisioning
AvailableThese endpoints allow you to provision new company accounts (recruiter access) and deactivate company access.
1. Provision Company
Registers or updates a company and its list of associated recruiters.
HTTP Request [POST]
https://parceiros.empregos.com.br/api/company/provision
- cURL
- C#
curl -X 'POST' \
'https://parceiros.empregos.com.br/api/company/provision' \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer any' \
-d '{
"externalCompanyId": "E1",
"companyName": "Empregos.com.br",
"nationalRegister": "12345678000199",
"productId": 10,
"recruiter": [
{
"externalRecruiterId": "R1",
"email": "recrutador@empregos.com.br",
"recruiterName": "José Silva"
}
]
}'
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
class Program
{
private const string ApiUrl = "https://parceiros.empregos.com.br/api/company/provision";
static async Task Main(string[] args)
{
using (HttpClient httpClient = new HttpClient())
{
httpClient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("bearer", "any");
var payload = new
{
externalCompanyId = "E1",
companyName = "Empregos.com.br",
nationalRegister = "12345678000199",
productId = 10,
recruiter = new[]
{
new
{
externalRecruiterId = "R1",
email = "recrutador@empregos.com.br",
recruiterName = "José Silva"
}
}
};
var json = JsonConvert.SerializeObject(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await httpClient.PostAsync(ApiUrl, content);
string result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
}
}
}
Parameters [Request]
| Field | Description | Type | Required |
|---|---|---|---|
| externalCompanyId | Unique identifier of the company in the partner system. Max 50 chars. | String | Yes |
| companyName | Company name. Max 100 chars. | String | Yes |
| nationalRegister | National registration ID (CNPJ). Max 20 chars. | String | Yes |
| productId | Product/Plan Code ID. Can be null. | Int | No |
| recruiter | List of recruiters to provision. | Array | Yes |
| recruiter.externalRecruiterId | Unique identifier of the recruiter. Max 50 chars. | String | Yes |
| recruiter.email | Email of the recruiter. Max 255 chars. | String | Yes |
| recruiter.recruiterName | Name of the recruiter. Max 200 chars. | String | Yes |
Responses
- 200 OK: Company and recruiters provisioned successfully. Returns a status report and redirection link for each recruiter.
{
"report": [
{
"externalRecruiterId": "R1",
"status": "Success",
"redirectUrl": "https://b2b.empregos.com.br/empresa/cadastro/comecar-cadastro&email=recrutador@empregos.com.br"
}
]
} - 400 BadRequest: Invalid payload or validation errors.
2. Deactivate Company Access
Deactivates access for all recruiters associated with the specified company and cancels their active plan.
HTTP Request [DELETE]
https://parceiros.empregos.com.br/api/company/provision
- cURL
- C#
curl -X 'DELETE' \
'https://parceiros.empregos.com.br/api/company/provision' \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer any' \
-d '{
"externalCompanyId": "E1",
"companyName": "Empregos.com.br",
"nationalRegister": "12345678000199",
"productId": 10,
"recruiter": []
}'
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
class Program
{
private const string ApiUrl = "https://parceiros.empregos.com.br/api/company/provision";
static async Task Main(string[] args)
{
using (HttpClient httpClient = new HttpClient())
{
httpClient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("bearer", "any");
var payload = new
{
externalCompanyId = "E1",
companyName = "Empregos.com.br",
nationalRegister = "12345678000199"
};
var request = new HttpRequestMessage(HttpMethod.Delete, ApiUrl)
{
Content = new StringContent(JsonConvert.SerializeObject(payload), Encoding.UTF8, "application/json")
};
var response = await httpClient.SendAsync(request);
string result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
}
}
}
Responses
- 200 OK: Access deactivated successfully.
{
"success": true,
"message": "Company deactivated successfully."
} - 400 BadRequest: Company not found or invalid payload.