Create an Invitation for a New User

POST /api/v1/invite

Base URL: https://user-management-api.wildberries.ru · Module: general · Section: Seller User Management · Specification doc ↗

Method is available by Personal token

The method creates an invitation for a new user with access settings to the seller account sections. How access rights are assigned:

• If access is empty ([]) or not provided — by default, all access is granted, except for access to the showcase (showcase) and **Jam** (changeJam)
• If access specifies some of the account sections, then in addition to the access rights specified in the request, all default access rights are also granted
• If access lists all possible sections, access rights will be granted according to the request, without the default access rights
• If the same section (code) is specified twice in access:
• with different disabled values (true and false), access will not be granted
• with identical values of "disabled": true, access will not be granted
• with identical values of "disabled": false, access will be granted

Request limit per one seller account:

Period	Limit	Interval	Burst
1 s	1 request	1 s	5 requests

Request body

application/json — schema createInviteRequest, required

• access object[] — Access settings for seller account sections
  • code string = balance | brands | changeJam | discountPrice | finance | showcase | suppliersDocuments | supply | questions | pinFeedbacks | pointsForReviews | feedbacks | oldAnalyticsReports | marketplace | brandsFlow | copyrightComplaints | pretrialClaims | sellersChat | brandzone | brandzoneSubscribe (required) — The code for the seller account section the user will get access to: * balance — View balance and withdraw funds * brands — Brands management * changeJam — Access to Jam subscription: A/B tests, photo tags, video autostarts, listing comparisons * discountPrice — Change item prices, manage discounts and promos * finance — Financial analytics. Balance statistics, financial reports, payment history * showcase — Showcase management * suppliersDocuments — View and download documents related to platform operations * supply — Create and manage FBW supplies * questions — View and respond to customer questions * pinFeedbacks — Ability to pin and unpin reviews * pointsForReviews — Points for reviews * feedbacks — View and respond to customer reviews * oldAnalyticsReports — Reports * marketplace — Seller Warehouse * brandsFlow — My brands * copyrightComplaints — Copyright Claims * pretrialClaims — Out-of-Court Claims * sellersChat — Chat with Users * brandzone — Edit Brand Zone * brandzoneSubscribe — Manage Brand Zone Subscription
  • disabled boolean (required) — * true — access to the section is disabled * false — access to the section is enabled
• invite object (required)
  • phoneNumber string (required) — User's phone number for the invitation. Phone numbers from the following countries are supported:• Armenia • Azerbaijan • Barbados • Belarus • Brazil • China • Czech Republic • Georgia • Hong Kong • Italy • Kazakhstan • Kyrgyzstan • Macau • Russia • Serbia • Sweden • Tajikistan • Turkey • UAE • Uzbekistan
  • position string — User's position

Responses

Code	Description	Schema
200	Success	createInviteResponse
400	Bad request	errorResponse
401	Unauthorized	object
403	Access denied	Response4XX
429	Too many requests	object

Structure 200:

• inviteID string<uuid> — Invitation ID
• expiredAt string — Date and time of expiration of the invitation
• isSuccess boolean — - true — the invitation was created successfully - false — retry the request
• inviteUrl string — The invitation URL that the user should follow

Structure 400:

• title string — Error title
• detail string — Error details
• requestId string — Request ID
• origin string — Internal service name
• status number — HTTP status code

Structure 401:

• title string — Error title
• detail string — Error details
• code string — Internal error code
• requestId string — Unique request ID
• origin string — WB internal service ID
• status number — HTTP status code
• statusText string — Text of the HTTP status code
• timestamp string — Request date and time

Structure 403:

• title string — Error title
• detail string — Error details
• code string — Internal error code
• requestId string — Request ID
• origin string — WB internal service ID
• status number — HTTP status code
• statusText string — Text of the HTTP status code
• timestamp string — Request date and time

Structure 429:

• title string — Error title
• detail string — Error details
• code string — Internal error code
• requestId string — Unique request ID
• origin string — WB internal service ID
• status number — HTTP status code
• statusText string — Text of the HTTP status code
• timestamp string — Request date and time

Call examples

Arguments are shown as parameter names — substitute your own values. Languages whose client does not expose this operation are omitted.

Python

from wb_api_client.general import Configuration, ApiClient
from wb_api_client.general.api import GeneralApi

cfg = Configuration(access_token="<your WB JWT>")
api = GeneralApi(ApiClient(cfg))

result = api.post_v1_invite(create_invite_request=...)
print(result)

TypeScript

import {
  Configuration,
  GeneralApi,
} from "@valeryverkhoturov/wb-api-client/general";

const cfg = new Configuration({});
cfg.setAccessToken("<your WB JWT>");
const api = new GeneralApi(cfg);

const { data } = await api.postV1Invite(createInviteRequest);
console.log(data);

Go

import (
	"context"
	"fmt"

	wbgeneral "github.com/ValeryVerkhoturov/wb-api-client-go/general"
)

cfg := wbgeneral.NewConfiguration()
cfg.SetAccessToken("<your WB JWT>")
client := wbgeneral.NewAPIClient(cfg)

result, _, err := client.GeneralAPI.PostV1Invite(context.Background()).CreateInviteRequest(createInviteRequest).Execute()
if err != nil {
    panic(err)
}
fmt.Printf("%+v\n", result)

Java

import io.github.valeryverkhoturov.wbapi.general.ApiClient;
import io.github.valeryverkhoturov.wbapi.general.SecretString;
import io.github.valeryverkhoturov.wbapi.general.api.GeneralApi;

ApiClient client = new ApiClient();
client.setAccessToken(new SecretString("<your WB JWT>"));
GeneralApi api = new GeneralApi(client);

System.out.println(api.postV1Invite(createInviteRequest));

PHP

use ValeryVerkhoturov\WbApiClient\General\Configuration;
use ValeryVerkhoturov\WbApiClient\General\SecretString;
use ValeryVerkhoturov\WbApiClient\General\Api\GeneralApi;
use GuzzleHttp\Client;

$config = (new Configuration())
    ->setAccessTokenSecret(new SecretString('<your WB JWT>'));
$api = new GeneralApi(new Client(), $config);

print_r($api->postV1Invite($create_invite_request));

OneScript

#Использовать "wb-api-client"

Настройки = Новый Конфигурация();
Настройки.УстановитьТокен("<your WB JWT>");
Клиент = Новый GeneralApi(Настройки);

Сообщить(Клиент.PostV1Invite(Тело).Тело);

C#

using ValeryVerkhoturov.WbApiClient.General.Api;
using ValeryVerkhoturov.WbApiClient.General.Client;

var config = new Configuration();
config.AccessTokenSecret = new SecretString("<your WB JWT>");
var api = new GeneralApi(config);

Console.WriteLine(api.PostV1Invite(createInviteRequest));

Rust

use wb_api_client::general::apis::{configuration::Configuration, general_api};

#[tokio::main]
async fn main() {
    let mut cfg = Configuration::new();
    cfg.set_access_token("<your WB JWT>");

    let result = general_api::post_v1_invite(&cfg, create_invite_request).await;
    println!("{:#?}", result);
}