Create a vendor

POST

/api/vendors

curl --request POST \
  --url https://api.getvespy.com/api/vendors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "isActive": true, "name": "example", "phone": "example", "trade": "example" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

email

string format: email

nullable

isActive

boolean

name

required

string

>= 1 characters <= 160 characters

phone

string

nullable >= 7 characters <= 32 characters

trade

string

nullable >= 1 characters <= 120 characters

Example^generated

{
  "email": "hello@example.com",
  "isActive": true,
  "name": "example",
  "phone": "example",
  "trade": "example"
}

Responses

201

Default Response

Media typeapplication/json

object

vendor

required

object

createdAt

required

string format: date-time

deletedAt

required

string format: date-time

nullable

email

required

string format: email

nullable

id

required

string format: uuid

isActive

required

boolean

name

required

string

>= 1 characters <= 160 characters

notes

required

string

nullable <= 2000 characters

organizationId

required

string format: uuid

phone

required

string

nullable >= 7 characters <= 32 characters

trade

required

string

nullable >= 1 characters <= 120 characters

updatedAt

required

string format: date-time

userId

required

string format: uuid

nullable

Example^generated

{
  "vendor": {
    "createdAt": "2026-04-15T12:00:00Z",
    "deletedAt": "2026-04-15T12:00:00Z",
    "email": "hello@example.com",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "isActive": true,
    "name": "example",
    "notes": "example",
    "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phone": "example",
    "trade": "example",
    "updatedAt": "2026-04-15T12:00:00Z",
    "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}