post https://app.ecwid.com/api/v3//staff
Create a staff account for a store by sending an invitation to an email.
To create staff accounts use secret token. The
invite_staffaccess scope is required. Reach out to us at [email protected] to add the scope.
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token. |
Request
A JSON object with the following fields:
Staff
| Field | Type | Description |
|---|---|---|
| string | Account email | |
| staffScopes | array of strings | Scopes declaring permissions for the staff account. See: Get staff scopes If scopes are not defined, staff account will have all scopes. |
A new staff account is created with the "inviteAccepted": false status. Staff members must accept the invite to get access.
Response
A JSON object with the following fields:
CreateStatus
| Field | Type | Description |
|---|---|---|
| success | boolean | Status of sent invitation |
Errors
In case of error, Ecwid responds with an error HTTP status code and JSON-formatted body containing error description.
HTTP codes
| HTTP Status | Response JSON | Description |
|---|---|---|
| 400 | Request parameters are malformed | |
| 409 | The customer with the given email already exists | |
| 415 | Unsupported content-type: expected application/json or text/json | |
| 500 | The creation request failed because of an error on the server |
Error response body (optional)
| Field | Type | Description |
|---|---|---|
| errorMessage | string | Error message |