Skip to main content
POST
/
settings
/
team
Create Team Member
curl --request POST \
  --url https://staging-api.puppetvendors.com/settings/team \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "email": "<string>",
  "password": "<string>",
  "profile": {},
  "profile.firstName": "<string>",
  "profile.lastName": "<string>",
  "profile.phone": "<string>",
  "apiPermissions": [
    "<string>"
  ]
}
'
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Create a new team member for the vendor account. The team member receives login credentials and can be assigned specific API permissions.

​
Use Cases

  • Invite warehouse staff with fulfillment-only permissions
  • Add a bookkeeper with read-only access to orders and payouts
  • Onboard new team members with scoped access

​
Request Body

​
email
string
required
Email address for the team member. Must be a valid email format.
​
password
string
required
Initial password. Minimum 6 characters, maximum 100 characters.
​
profile
object
Profile information.
​
profile.firstName
string
First name. Maximum 100 characters.
​
profile.lastName
string
Last name. Maximum 100 characters.
​
profile.phone
string
Phone number. Maximum 50 characters.
​
apiPermissions
string[]
Array of permission strings to grant the team member.

​
Response

200
{
  "success": true,
  "data": {
    "_id": "665a1b2e3d98f0001a2b3c81",
    "email": "bob@example.com",
    "profile": {
      "firstName": "Bob",
      "lastName": "Smith",
      "phone": "+15125559876"
    },
    "apiPermissions": [
      "orders:read",
      "fulfillments:write"
    ],
    "createdAt": "2026-05-19T12:00:00.000Z"
  }
}

​
Example

curl -X POST "https://staging-api.puppetvendors.com/settings/team" \
  -H "x-access-token: YOUR_VENDOR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "bob@example.com",
    "password": "secureP@ss123",
    "profile": {
      "firstName": "Bob",
      "lastName": "Smith",
      "phone": "+15125559876"
    },
    "apiPermissions": ["orders:read", "fulfillments:write"]
  }'

​
More Examples

Create team member with limited permissions 
curl -X POST "https://staging-api.puppetvendors.com/settings/team" \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_VENDOR_TOKEN" \
  -d '{
    "email": "assistant@acmeco.com",
    "password": "temp-pass-123",
    "profile": {
      "firstName": "Alex",
      "lastName": "Johnson"
    },
    "apiPermissions": ["orders:read", "products:read", "fulfillments:read"]
  }'