API referenceEnterprises
Update an enterprise
PATCH
Changes the fields you send and leaves the rest unchanged.
The body is a JSON merge patch (RFC 7396): null clears a field
that can be empty. address, contact and billing are replaced
whole. external_ref can be set once and cannot change after that.
integrationKeyheader
AuthorizationBearer <token>Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>.
Konsol issues it.
id*stringFormat
uuid- body
Properties
1 <= propertiesexternal_ref?ExternalRefYour own reference for a record: any format, compared exactly and case-sensitively. Leading or trailing whitespace is refused rather than trimmed, so a stored reference always matches what was sent.
Match
^\S(.*\S)?$Length
1 <= length <= 128name?stringLength
1 <= length <= 255status?stringValue in
"active""inactive"business_reg_no?|Length
1 <= length <= 12address?|nullThe updated enterprise
application/json- response
id*stringFormat
uuidexternal_ref?|nullname*stringstatus*stringValue in
"active""inactive"business_reg_no?string|nulladdress?|nullcreated_at*stringFormat
date-timeupdated_at*stringFormat
date-timedeleted_at*|When the record was deleted, or null. Lists return deleted records only with include_deleted=true.
Format
date-timeExample Request
curl -X PATCH 'https://api.konsol.my/integration/v1/enterprises/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "external_ref": "ACQ-MBB", "name": "string", "status": "active", "business_reg_no": "string", "address": { "line1": "string", "line2": "string", "city": "string", "postcode": "string", "state": "MY-01", "country": "MY" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z"}