Business Create

POST 
/api/v2/admin/business

Business Create

Request

application/json

Body

required

The attributes property can contain any type of value, be it strings, numbers, arrays, or key and value structures.

name Namerequired

Assign a name to your business.

attributes object

Default value: [object Object]

Define custom attributes for each deal.

Responses

201

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.592Z",
  "updatedAt": "2024-04-14T14:11:05.592Z",
  "deletedAt": "2024-04-14T14:11:05.592Z"
}

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