Update Business

PUT 
/api/v2/business/:businessId

Update Business

Request

Path Parameters

businessId stringrequired

Business ID.

application/json

Body

required

The attributes property will be completely overwritten with this one. Therefore, before performing the update, recover the data, make the modification and update.

name Name

Assign a name to your business.

attributes object

Define custom attributes for each deal.

Responses

200

BusinessCreateResponse

application/json

Schema

Schema

businessId stringrequired
name stringrequired
businessToken stringrequired
attributes objectrequired
createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired

Example (from schema)

{
  "businessId": "string",
  "name": "string",
  "businessToken": "string",
  "attributes": {},
  "createdAt": "2024-04-14T14:11:05.601Z",
  "updatedAt": "2024-04-14T14:11:05.601Z",
  "deletedAt": "2024-04-14T14:11:05.601Z"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...