Skip to main content

Company Provisioning

Available

These 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 -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"
}
]
}'

Parameters [Request]

FieldDescriptionTypeRequired
externalCompanyIdUnique identifier of the company in the partner system. Max 50 chars.StringYes
companyNameCompany name. Max 100 chars.StringYes
nationalRegisterNational registration ID (CNPJ). Max 20 chars.StringYes
productIdProduct/Plan Code ID. Can be null.IntNo
recruiterList of recruiters to provision.ArrayYes
recruiter.externalRecruiterIdUnique identifier of the recruiter. Max 50 chars.StringYes
recruiter.emailEmail of the recruiter. Max 255 chars.StringYes
recruiter.recruiterNameName of the recruiter. Max 200 chars.StringYes

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 -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": []
}'

Responses

  • 200 OK: Access deactivated successfully.
    {
    "success": true,
    "message": "Company deactivated successfully."
    }
  • 400 BadRequest: Company not found or invalid payload.