Перейти к содержимому

Добавить сотрудника

POST
/v1/orgs/{id}/members
curl --request POST \
--url https://api.rekassa.uz/v1/orgs/example/members \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "phone": "example", "firstName": "example", "lastName": "example", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "branchId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

По номеру телефона. Если аккаунта нет, он создаётся: сотрудник войдёт по SMS-коду. Роль — клиентская, ранга ниже вашего; branchId ограничивает её одним филиалом.

id
required
string
Media typeapplication/json
object
phone
required
string
firstName
required
string
>= 1 characters <= 100 characters
lastName
required
string
>= 1 characters <= 100 characters
roleId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
branchId

Limit the role to one branch

string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Examplegenerated
{
"phone": "example",
"firstName": "example",
"lastName": "example",
"roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"branchId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
Media typeapplication/json
object
userId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
phone
required
string
firstName
required
string
lastName
required
string
status
required
string
Allowed values: pending active blocked
hasPin
required
boolean
roles
required
Array<object>
object
assignmentId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
scope
required
object
type
required
string
Allowed values: client organization branch
clientId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
organizationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
branchId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
role
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
code
required
string
nullable
name
required
string
rank
required
integer
>= -9007199254740991 <= 9007199254740991
Example
{
"status": "pending",
"roles": [
{
"scope": {
"type": "client"
}
}
]
}

Request is malformed (validation_failed)

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required

Localized by Accept-Language

string
details
object
key
additional properties
requestId
required
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {
"additionalProperty": "example"
},
"requestId": "example"
}
}

Not authenticated

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required

Localized by Accept-Language

string
details
object
key
additional properties
requestId
required
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {
"additionalProperty": "example"
},
"requestId": "example"
}
}

Not allowed

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required

Localized by Accept-Language

string
details
object
key
additional properties
requestId
required
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {
"additionalProperty": "example"
},
"requestId": "example"
}
}

Not found

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required

Localized by Accept-Language

string
details
object
key
additional properties
requestId
required
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {
"additionalProperty": "example"
},
"requestId": "example"
}
}

Conflicts with the current state

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required

Localized by Accept-Language

string
details
object
key
additional properties
requestId
required
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {
"additionalProperty": "example"
},
"requestId": "example"
}
}

Business rule violated

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required

Localized by Accept-Language

string
details
object
key
additional properties
requestId
required
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {
"additionalProperty": "example"
},
"requestId": "example"
}
}