v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Adicionar região

post/regions

Request body

namestring required

Nome da região.

region_idinteger

ID da região-mãe (se este atributo for preenchido, a região torna-se uma microrregião).

leadersinteger[]

Array contendo os IDs dos usuários líderes da região. Caso exista mais de um líder, deve-se separar os IDs por vírgula, exemplo: [12512, 12452]..

usersinteger[]

Array contendo os IDs dos usuários que terão acesso à região e poderão receber a distribuição de leads. Caso exista mais de um usuário, deve-se separar os IDs por vírgula, exemplo: [12512, 12452].

cep_frominteger

CEP inicial da região Formato: "00000000".

cep_tointeger

CEP final da região Formato: "00000000".

Response

201

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Created",
  "data": {
    "id": 748,
    "account_id": 748,
    "region_id": 1,
    "city_id": 1,
    "last_user_id": 1,
    "name": "Metropolis Region",
    "cep_to": "22550000",
    "cep_from": "22550000",
    "cities": {
      "id": 5,
      "uf": "RO",
      "name": "Cerejeiras"
    }
  }
}