PUT api/v1/entities/{id}

Edits an entity by ID, if it doesn't exist, it creates a new one returning its ID

Request Information

URI Parameters

Name Description Type Additional information
id ID of the entity you want to edit integer Required

Body Parameters

Request body values

Name Description Type Additional information
EntityID integer No additional information available.
Number Number of the entity. You can leave it null to auto calculate integer Range: inclusive between 0 and 9,22337203685478E+18
CivilState Civil state of the entity CivilState No additional information available.
Observation Observation for the entity string Max length: 1000
Name Name of the entity string Required Max length: 150
ChildrenCount Number of children of the entity byte Range: inclusive between 0 and 255
BirthDate Birthdate of the entity. Can be null date No additional information available.
VatNumber VAT number of the entity. If null, one will be added by default string Max length: 50
Iban IBAN of the entity string Max length: 50
Status Entity status EntityStatus No additional information available.
Email Entity email string Max length: 100
Phone Entity Phone string Max length: 50
Mobile Entity Mobile string Max length: 50
Fax Entity Fax string Max length: 50
Url Entity website string Max length: 300
City Entity City string Required Max length: 100
CountryID Entity Country byte Must be a valid country
Code Entity Code string Max length: 200
Street Entity Street string Max length: 500
Region Entity Region string Max length: 50
IgnoreAdvertising True if you want your entity to ingore ads. Default is true boolean No additional information available.

Request Formats

application/json, text/json

  "entityID": 1,
  "number": 2,
  "civilState": 0,
  "observation": "sample string 3",
  "name": "sample string 4",
  "childrenCount": 64,
  "birthDate": "2022-08-15T08:40:25.3604087+01:00",
  "vatNumber": "sample string 6",
  "iban": "sample string 7",
  "status": 0,
  "email": "sample string 8",
  "phone": "sample string 9",
  "mobile": "sample string 10",
  "fax": "sample string 11",
  "url": "sample string 12",
  "city": "sample string 13",
  "countryID": 64,
  "code": "sample string 14",
  "street": "sample string 15",
  "region": "sample string 16",
  "ignoreAdvertising": true

Response Information

Resource Description

No information available

Response Formats

application/json, text/json