POST Invite new vendors
Invite new vendors based on the criteria provided
Header Parameters
- x-forwarded-for X-Forwarded-For
- Accept Accept
- Content-Type Content-Type
- application/vnd.stavvy-1.0+json
Request Body required
- name Name required
- contactEmail Contactemail required
- contactPhone Contactphone
- contactFirstName Contactfirstname required
- contactLastName Contactlastname required
- domain Domain
- branch Branch
location object required
streetNumber Streetnumber requiredstreetName Streetname requiredapartmentUnit Apartmentunitcounty Countycity City requiredusState Usstate requiredpostalCode Postalcode required- force Force
Default value:
false
Responses
- 200
- 300
- 400
- 403
- 409
- 422
Was able to successfully invite a new vendor
- application/vnd.stavvy-1.0+json
- Schema
- Example (from schema)
Schema
- id Id required
- name Name required
- domain Domain
- branch Branch
- primaryPhone Primaryphone
- createdAt Createdat required
- updatedAt Updatedat required
location object
street Street requiredapartmentUnit Apartmentunitcity City requiredcounty CountyusState Usstate requiredpostalCode Postalcode required- relationshipStatus Relationshipstatus required
- sourceVendorId Sourcevendorid required
{
"id": 0,
"name": "string",
"domain": "string",
"branch": "string",
"primaryPhone": "string",
"createdAt": "string",
"updatedAt": "string",
"location": {
"street": "string",
"apartmentUnit": "string",
"city": "string",
"county": "string",
"usState": "string",
"postalCode": "string"
},
"relationshipStatus": "string",
"sourceVendorId": 0
}
Multiple vendors were found which too closely matched parameters given
One of the arguments given was not a valid argument
Did not have the correct permissions to invite a vendor
A vendor already has that exact email address so they cannot be invited
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
detail object[]
Array [loc object[] required
Array [- anyOf
- MOD1
- MOD2
stringinteger]msg Message requiredtype Error Type required]
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
Loading...