Atualizar região

put/regions/{region_id}

Request

Base URL
https://api.pipe.run/v1
Auth
API key in header token
TypeScript
https://skmtc.dev/pipe/apis/application-json/docs/regions/:region_id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

region_idinteger required

ID da região.

Request body

namestring

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).

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"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.