Edit Job

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://vaas.vag.as/doc/publicacao-vagas-en/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "publicacao-vagas-en MCP server": {
    "url": "https://vaas.vag.as/doc/publicacao-vagas-en/mcp"
  }
}

Close
PATCH /job-posting/jobs/{id}

Endpoint to edit job in the Vagas for Business system

The attributes cargo, descrição do anuncio and outros requisitos do anúncio accept some HTML tags, allowed options are listed below.

Allowed HTML tags:

  • span
  • br
  • p
  • ul
  • ol
  • li
  • b
  • i
  • u
  • strong
  • em
  • div
  • h1
  • h2
  • h3
  • h4
  • h5
  • h6

Path parameters

  • id string Required

    Job ID

application/json

Body Required

  • notificar array[string]

    List of emails to send notification when the job is published

  • cargo string

    Job title

  • cargo_exclusivo_pcd boolean

    Flag to mark if the job is for people with a disability only

  • tipo_de_contratacao_id integer

    Contract type ID. can be obtained in the endpoint /v1/dominios/modelos-contratuais

  • numero_de_posicoes integer

    Open positions of the job

  • idiomas array[object]

    Required Languages for the job, they can be obtained in the endpoint /v1/dominios/idiomas

    Hide idiomas attributes Show idiomas attributes object
    • id integer Required
    • nivel_id integer Required

      Level ID

      • 1 - None
      • 2 - Basic
      • 3 - Intermediate
      • 4 - Advanced
      • 5 - Fluent

      Values are 1, 2, 3, 4, or 5.

  • beneficios array[object]

    Benefits offered. Os ids podem ser obtidos no endpoint v1/job-posting/benefits. the beneft can not be added twice in the same job

    Hide beneficios attributes Show beneficios attributes object
    • id integer Required
    • valor number

      Value

  • anuncio object
    Hide anuncio attributes Show anuncio attributes object
    • descricao string Required

      Description of the job

    • outros_requisitos string Required

      Field to add other requirements for the job

  • salario object

    Salary fields

    Hide salario attributes Show salario attributes object
    • tipo_moeda string

      Currency of the salary, if exibir_salario_no_anuncio is true, this field is required

      Values are BRL or USD.

    • faixa_salario_min number

      Minimum value of the salary range, if exibir_salario_no_anuncio is true, this field is required

    • faixa_salario_max number

      Maximum vlaue of the salary range, if exibir_salario_no_anuncio is true, this field is required

    • exibir_salario_no_anuncio boolean Required

      If false, the salary will be in agreement

  • pre_requisitos object
    Hide pre_requisitos attributes Show pre_requisitos attributes object
    • escolaridade_minima_id integer Required

      Minimum education level, the ID can be obtained in the endpoint v1/dominios/niveis_de_escolaridade If education is indifferent to the job, pass the value "-1"

    • nivel_hierarquico_id integer Required

      hierarchical level. The ID can be obtained in the endpoint /v1/dominios/niveis_hierarquicos

    • areas_de_atuacao_ids array[integer] Required

      Fields of activity of the job. The IDs can be obtained in the endpoint /v1/dominios/setores

  • atuacao object
    Hide atuacao attributes Show atuacao attributes object
    • modelo_de_trabalho integer Required

      Work model. The ID can be obtained in the endpoint /v1/dominios/modelos-locais-trabalho

    • aceitar_candidaturas Deprecated

      DEPRECATED

    • local_aceita_candidaturas string

      Enum with the location which the application is accepted, apenas da cidade, cidades próximas or qualquer cidade. If the value is somente_cidade, accepts applicants who have registered the city of the job in the region of interest with the "Use my address" option turned on. If the value is cidades_proximas, accepts applicants who have registered the city of the job in the region of interest with the "Use my address" option turned on that are close to the city of the job (distance of up to 50 km). If the value is qualquer_cidade, accepts applicants who have registered the city of the job in the region of interest.

      • somente_cidade - City only
      • cidades_proximas - Nearby cities
      • qualquer_cidade - Any city

      Values are somente_cidade, cidades_proximas, or qualquer_cidade.

    • local_de_trabalho object Required
      Hide local_de_trabalho attributes Show local_de_trabalho attributes object
      • pais_id integer

        Country ID The ID can be obtained in the endpoint /v1/dominios/paises/.

      • estado_id integer

        State ID The ID can be obtained in the endpoint /v1/dominios/paises/:pais_id/estados.

      • cidade_id integer

        City ID The ID can be obtained in the endpoint /v1/dominios/paises/:pais_id/estados/:estado_id/cidades.

  • sobre_a_empresa object
    Hide sobre_a_empresa attributes Show sobre_a_empresa attributes object
    • anuncio_confidencial boolean Required

      Confidential job If true, the company's name will not be displayed in the job description.

    • apresentacao_da_empresa integer

      Company presentation. The ID can be obtained in the endpoint /v1/job-posting/presentations.

  • periodo_de_inscricao object Required

    The period that the job will accept applications

    Hide periodo_de_inscricao attributes Show periodo_de_inscricao attributes object
    • data_inicio string Required

      Start date

    • data_fim string Required

      End date

    • veiculacao_suspensa boolean

      Flag to suspend/pause the job offer. If true will not be listed in the Vagas for Business system

  • acesso_restrito object

    Fields mark the access to the job restricted.

    Hide acesso_restrito attributes Show acesso_restrito attributes object
    • vaga_restrita boolean Required

      If true only people with the job url will be able to access it.

    • senha string

      If the value of "vaga_restrita" is true, you can define a password, only who has the url and the password will be able to access it.

  • canais_de_divulgacao object
    Hide canais_de_divulgacao attributes Show canais_de_divulgacao attributes object
    • divisao_id integer Required

      Job division. The ID can be obtained in the endpoint /v1/job-posting/divisions

    • parceiros_ids array[integer] Required

      Partner channels. The ID(s) can be obtained in the endpoint /v1/job-posting/divisions

  • vaga_inteligente boolean

    If the value is true, the job will be published as a smart job

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer
    • cargo_exclusivo_pcd boolean

      Flag to show if the job is for people with a disability only

    • cargo string

      Job title

    • numero_de_posicoes integer

      Number of positions offered

    • tipo_de_contratacao_id integer

      Contract type id

    • funcionario_id integer

      Employee ID

    • empresa_id integer

      Company ID

    • data_criacao string
    • fases_ids array[integer]

      Phases IDs

    • canais_de_divulgacao object
      Hide canais_de_divulgacao attributes Show canais_de_divulgacao attributes object
      • divisao_id integer

        Division ID

      • parceiros_ids array[integer]

        Partner channels IDs

    • acesso_restrito object
      Hide acesso_restrito attribute Show acesso_restrito attribute object
      • vaga_restrita boolean

        Job with restrict access

    • sobre_a_empresa object

      About the company

      Hide sobre_a_empresa attributes Show sobre_a_empresa attributes object
      • anuncio_confidencial boolean
      • apresentacao_da_empresa integer
    • anuncio object
      Hide anuncio attributes Show anuncio attributes object
      • descricao string

        Job description

      • outros_requisitos string

        Other job requirements

    • periodo_de_inscricao object

      Application period

      Hide periodo_de_inscricao attributes Show periodo_de_inscricao attributes object
      • data_inicio string

        Start date

      • data_fim string

        End date

      • veiculacao_suspensa boolean

        application paused

    • salario object

      Salary fields

      Hide salario attributes Show salario attributes object
      • tipo_moeda string

        Type of currency

        Values are BRL or USD.

      • faixa_salario_min number

        Salary range minimum

      • faixa_salario_max number

        Salary range Maximum

      • exibir_salario_no_anuncio boolean

        Show salary in the job announcement

    • idiomas array[object]

      Languages

      Hide idiomas attributes Show idiomas attributes object
      • id integer
      • nivel_id integer

        Level id

    • pre_requisitos object
      Hide pre_requisitos attributes Show pre_requisitos attributes object
      • escolaridade_minima_id integer

        Minimum education level

      • nivel_hierarquico_id integer

        Hierarchical level ID

      • areas_de_atuacao_ids array[integer]

        Fields of Activity IDs

    • atuacao object
      Hide atuacao attributes Show atuacao attributes object
      • modelo_de_trabalho integer

        Work model ID

      • local_aceita_candidaturas string

        Accept application region

        • somente_cidade - City only
        • cidades_proximas - Nearby cities
        • qualquer_cidade - Any city

        Values are somente_cidade, cidades_proximas, or qualquer_cidade.

      • local_de_trabalho object

        Work local

        Hide local_de_trabalho attributes Show local_de_trabalho attributes object
        • localizacao_completa string

          Full location

        • pais string

          Country

        • estado string

          State

        • cidade string

          City

        • cidade_id integer

          City ID

    • fichas_gerenciais array[object]

      Management forms

      Hide fichas_gerenciais attribute Show fichas_gerenciais attribute object
      • id integer
    • beneficios array[object]

      Benefits

      Hide beneficios attributes Show beneficios attributes object
      • id integer
      • valor number

        Value

    • fichas array[object]

      Forms

      Hide fichas attributes Show fichas attributes object
      • id integer
      • obrigratoria boolean

        Required

    • vaga_inteligente boolean
PATCH /job-posting/jobs/{id}
curl \
 --request PATCH 'https://apigateway.vagas.com.br/v1/job-posting/jobs/23423' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "notificar": [
    "contact@company.com",
    "hr@email.com"
  ],
  "cargo": "engineer",
  "cargo_exclusivo_pcd": false,
  "tipo_de_contratacao_id": 999,
  "numero_de_posicoes": 999,
  "idiomas": [
    {
      "id": 534,
      "nivel_id": 5
    }
  ],
  "beneficios": [
    {
      "id": 2,
      "valor": 80
    }
  ],
  "anuncio": {
    "descricao": "Job description",
    "outros_requisitos": "English certificate"
  },
  "salario": {
    "tipo_moeda": "BRL",
    "faixa_salario_min": 999,
    "faixa_salario_max": 999,
    "exibir_salario_no_anuncio": true
  },
  "pre_requisitos": {
    "escolaridade_minima_id": 1,
    "nivel_hierarquico_id": 3,
    "areas_de_atuacao_ids": [
      4,
      6,
      10
    ]
  },
  "atuacao": {
    "modelo_de_trabalho": 4,
    "local_aceita_candidaturas": "cidades_proximas",
    "local_de_trabalho": {
      "pais_id": 999,
      "estado_id": 999,
      "cidade_id": 999
    }
  },
  "sobre_a_empresa": {
    "anuncio_confidencial": false,
    "apresentacao_da_empresa": 999
  },
  "periodo_de_inscricao": {
    "data_inicio": "2024/01/01",
    "data_fim": "2024/01/01",
    "veiculacao_suspensa": false
  },
  "acesso_restrito": {
    "vaga_restrita": false,
    "senha": "S3nh@"
  },
  "canais_de_divulgacao": {
    "divisao_id": 999,
    "parceiros_ids": [
      999
    ]
  },
  "vaga_inteligente": false
}'
Request examples
{
  "notificar": [
    "contact@company.com",
    "hr@email.com"
  ],
  "cargo": "engineer",
  "cargo_exclusivo_pcd": false,
  "tipo_de_contratacao_id": 999,
  "numero_de_posicoes": 999,
  "idiomas": [
    {
      "id": 534,
      "nivel_id": 5
    }
  ],
  "beneficios": [
    {
      "id": 2,
      "valor": 80
    }
  ],
  "anuncio": {
    "descricao": "Job description",
    "outros_requisitos": "English certificate"
  },
  "salario": {
    "tipo_moeda": "BRL",
    "faixa_salario_min": 999,
    "faixa_salario_max": 999,
    "exibir_salario_no_anuncio": true
  },
  "pre_requisitos": {
    "escolaridade_minima_id": 1,
    "nivel_hierarquico_id": 3,
    "areas_de_atuacao_ids": [
      4,
      6,
      10
    ]
  },
  "atuacao": {
    "modelo_de_trabalho": 4,
    "local_aceita_candidaturas": "cidades_proximas",
    "local_de_trabalho": {
      "pais_id": 999,
      "estado_id": 999,
      "cidade_id": 999
    }
  },
  "sobre_a_empresa": {
    "anuncio_confidencial": false,
    "apresentacao_da_empresa": 999
  },
  "periodo_de_inscricao": {
    "data_inicio": "2024/01/01",
    "data_fim": "2024/01/01",
    "veiculacao_suspensa": false
  },
  "acesso_restrito": {
    "vaga_restrita": false,
    "senha": "S3nh@"
  },
  "canais_de_divulgacao": {
    "divisao_id": 999,
    "parceiros_ids": [
      999
    ]
  },
  "vaga_inteligente": false
}
Response examples (200)
{
  "id": 2505124,
  "cargo_exclusivo_pcd": false,
  "cargo": "Analista de crédito",
  "numero_de_posicoes": 2,
  "tipo_de_contratacao_id": 4,
  "funcionario_id": 17742,
  "empresa_id": 12702,
  "data_criacao": "2023-05-03T11:13:34-03:00",
  "fases_ids": [
    469731,
    649710,
    641396
  ],
  "canais_de_divulgacao": {
    "divisao_id": 67518,
    "parceiros_ids": [
      11,
      10
    ]
  },
  "acesso_restrito": {
    "vaga_restrita": true
  },
  "sobre_a_empresa": {
    "anuncio_confidencial": false,
    "apresentacao_da_empresa": 139
  },
  "anuncio": {
    "descricao": "Descrição da Vaga",
    "outros_requisitos": "sem comentários"
  },
  "periodo_de_inscricao": {
    "data_inicio": "2023-05-03",
    "data_fim": "2023-05-03T21:00:00-03:00",
    "veiculacao_suspensa": false
  },
  "salario": {
    "tipo_moeda": "BRL",
    "faixa_salario_min": 1500,
    "faixa_salario_max": 2000,
    "exibir_salario_no_anuncio": true
  },
  "idiomas": [
    {
      "id": 20,
      "nivel_id": 2
    }
  ],
  "pre_requisitos": {
    "escolaridade_minima_id": 60,
    "nivel_hierarquico_id": 40,
    "areas_de_atuacao_ids": [
      70,
      1,
      124
    ]
  },
  "atuacao": {
    "modelo_de_trabalho": 2,
    "local_aceita_candidaturas": "somente_cidade",
    "local_de_trabalho": {
      "localizacao_completa": "Angra dos Reis, RJ, Brasil",
      "pais": "Brasil",
      "estado": "RJ",
      "cidade": "Angra dos Reis",
      "cidade_id": 60968
    }
  },
  "fichas_gerenciais": [
    {
      "id": 23
    }
  ],
  "beneficios": [
    {
      "id": 2,
      "valor": 34.5
    }
  ],
  "fichas": [
    {
      "id": 147637,
      "obrigratoria": true
    }
  ],
  "vaga_inteligente": false
}