Skip to main content
PUT
Node.js

Authorizations

Authorization
string
header
required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Headers

Idempotency-Key
string

A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with Idempotent-Replay: true.

Path Parameters

storeId
string
required

The store's ID. A key reaches the store it was made in: GET /key answers which.

teamId
string
required

The team, by its ID.

Body

application/json
name
string
required

What the team is called, up to 40 characters, once a store.

Example:

"Support"

permissions
string[]
required

What its people may do, by name (List the team answers every permission in permissions). What a permission leans on is added with it: stock.edit brings stock.view and products.view.

Example:

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object