Create and send vendor invite

POST

/api/vendor-invites

curl --request POST \
  --url https://api.getvespy.com/api/vendor-invites \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Responses

201

Default Response

Media typeapplication/json

object

emailDelivery

required

object

error

string

nullable

messageId

string

nullable

provider

required

string

status

required

string

Allowed values: sent failed

invite

required

object

acceptedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

createdByUserId

required

string format: uuid

nullable

email

required

string format: email

expiresAt

required

string format: date-time

id

required

string format: uuid

organizationId

required

string format: uuid

revokedAt

required

string format: date-time

nullable

status

required

string

Allowed values: pending accepted expired

token

required

string

>= 1 characters

vendorId

required

string format: uuid

inviteLink

required

string format: uri

Example

{
  "emailDelivery": {
    "status": "sent"
  },
  "invite": {
    "status": "pending"
  }
}

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"
}

404

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"
}