Criando prospecções de candidatos

Headers necessários:

Uma vez que os Headers estejam devidamente configurados, podemos ir ao próximo passo.

Nome	Valor	Descrição
Authorization	Bearer [SEU_TOKEN]	Bearer token para autenticação. Saiba mais aqui.
Content-Type	multipart/form-data	Define o tipo de formato de conteúdo que será enviado.

Uma vez que os Headers estejam devidamente configurados, podemos ir ao próximo passo.

Endpoint utilizado para criar uma prospecção:

Endpoint	Método	Link para Teste
/api/v2/prospects	POST	Loading...

Payload

Definição campo a campo para criar uma prospecção na API:

Campo	Tipo	Obrigatório	Descrição
prospect_acquisition_channel_id	int	Sim	ID do canal de aquisição do prospect.
name	string	Sim	Nome completo do candidato.
pipe_stage_id	int	Sim	ID do estágio do pipeline em que o candidato será inserido.
vacancy_id	int	Sim	ID da vaga à qual o candidato será vinculado.
email	string	Sim	Endereço de e-mail do candidato.
telephone	string	Sim	Telefone de contato no formato (DDD) número).

Exemplo de resposta

{
    "message": "Ação realizada com sucesso!",
    "data": {
        "talent": {
            "id": 9876543,
            "uuid": "a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78",
            "user_id": null,
            "scholarity_id": null,
            "study_field_id": null,
            "description": null,
            "course": null,
            "birthday": null,
            "gender": 7,
            "social_name": null,
            "breed_id": null,
            "pronoun_id": null,
            "policy_and_privacy": null,
            "conditions_terms": null,
            "is_public": 0,
            "is_egression": null,
            "ssn": null,
            "personal_values": null,
            "telephone": "+55 (11) 91234-5678",
            "telephone_alt": null,
            "pcd": false,
            "pcd_reability": null,
            "photo_filename": null,
            "avatar": null,
            "facebook_url": null,
            "linkedin_url": null,
            "linkedin_username": null,
            "github_url": null,
            "website_url": null,
            "created_at": "2025-11-10 15:12:08",
            "updated_at": "2025-11-10 15:12:09",
            "deleted_at": null,
            "recrutest_requested": null,
            "last_request": null,
            "curriculum_filename": null,
            "marital_status": null,
            "is_prospect": 1,
            "recrutest_url": null,
            "curriculum_url": null,
            "photo_url": null,
            "age": 0,
            "accepted_last_privacy_term": null,
            "pcd_string": null,
            "breed_name": null,
            "pronoun_name": null,
            "gender_name": "Prefiro não responder",
            "deficiencies": null,
            "prospect": {
                "id": 321987,
                "talent_id": 9876543,
                "manager_id": 5555,
                "company_id": 1234,
                "external_id": null,
                "prospect_acquisition_channel_id": 8,
                "photo": "https://recrutei-web.s3.amazonaws.com/storage/files/prospects/photo/",
                "name": "João Silva",
                "email": "[email protected]",
                "referred_by": "Roberto Souza",
                "annotation_filename": null,
                "summary": null,
                "industry_name": null,
                "headline": null,
                "location": "São Paulo, SP",
                "created_at": "2025-11-10 15:12:08",
                "updated_at": "2025-11-10 15:12:08",
                "example": 0,
                "first_name": "João",
                "talent_prospect_fields": []
            },
            "applications": [
                {
                    "id": 778899,
                    "vacancy_id": 445566,
                    "talent_id": 9876543,
                    "company_id": 1234,
                    "manager_id": 5555,
                    "pipe_stage_id": 98765,
                    "created_at": "2025-11-10 15:12:08",
                    "updated_at": "2025-11-10 15:12:08",
                    "deleted_at": null,
                    "rated": null,
                    "prospect_id": null,
                    "stars": 0,
                    "reproved_reason_id": null,
                    "rated_at": null,
                    "viewed_at": null,
                    "reproved_by": null,
                    "status": 1,
                    "inappropriate": null,
                    "channel": "manual",
                    "index": 0,
                    "index_updated_at": null,
                    "application_withdrawal_id": null,
                    "last_pipe_stage_time": null
                }
            ],
            "user": null,
            "breed": null,
            "pronoun": null,
            "gender_identity": {
                "id": 7,
                "uuid": "xyz12345-fd45-4b21-9b10-7256c212b5c5",
                "order": 7,
                "name": "Prefiro não responder",
                "description": null
            }
        },
        "application": {
            "id": 778899,
            "prospect": {
                "id": 321987,
                "talent_id": 9876543,
                "manager_id": 5555,
                "company_id": 1234,
                "external_id": null,
                "prospect_acquisition_channel_id": 8,
                "photo": "https://recrutei-web.s3.amazonaws.com/storage/files/prospects/photo/",
                "name": "João Silva",
                "email": "[email protected]",
                "referred_by": "Roberto Souza",
                "annotation_filename": null,
                "summary": null,
                "industry_name": null,
                "headline": null,
                "location": "São Paulo, SP",
                "created_at": "2025-11-10 15:12:08",
                "updated_at": "2025-11-10 15:12:08",
                "example": 0,
                "first_name": "João"
            },
            "pipe_stage_id": "98765",
            "curriculum_url": null,
            "created_at": "2025-11-10T18:12:08.000000Z"
        }
    }
}