Create vendor

post

https://www.pelcro.com/api/v1/core/vendors

Create a new vendor.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Create a new vendor with contact information. The vendor is created as a user with type vendor on the site.

Example: Add a freelance writer as a vendor so you can create bills for their work.

Important Behaviors

Email uniqueness: The email must be unique among vendors on the same site.
Event fired: vendor.created event is dispatched after successful creation.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

first_name

string

required

length ≤ 255

Vendor first name. Required.

last_name

string

required

length ≤ 255

Vendor last name. Required.

string

required

length ≤ 255

Vendor email. Must be unique among vendors on the site.

phone

string

length ≤ 20

Phone number.

birthdate

date

Birthdate in YYYY-MM-DD format.

job_title

string

length ≤ 255

Job title.

company

string

length ≤ 255

Company name.

address

string

length ≤ 255

Street address.

city

string

length ≤ 100

City.

state

string

length ≤ 100

State or province.

country

string

length ≤ 100

Country.

postal_code

string

length ≤ 20

Postal/ZIP code.

metadata

object

Custom metadata key-value pairs.

delivery_service_area_prompt

string

AI delivery service area prompt.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Overview

Important Behaviors

200Success.

400Invalid request.

401Unauthenticated.