addPassportOrganizationMember
Adds a new member to a Yandex ID organization.
The limit is 10 invites per PassportOrganizationLogin a day.
Learn more
Request
Request structure in JSON format:
{
"method": "addPassportOrganizationMember",
"params": {
"PassportOrganizationLogin": (string),
"Role": ("ADMIN"|"USER"),
"SendInviteTo": {
"Phone": (string),
"Email": (string),
},
}
}
|
Parameter |
Type |
Description |
Required |
|
params structure (for JSON) / AddPassportOrganizationMember (for SOAP) |
|||
|
|
string |
Username of the Yandex ID organization where you want to add a new member. |
Yes |
|
|
RoleEnum |
The role with which the new participant will be added to the Yandex ID organization. The parameter may take one of the two values:
|
Yes |
|
|
SendInviteTo |
Sets the method for sending an invite to a Yandex ID organization. |
Yes |
|
MemberInvite structure |
|||
|
|
string |
Phone number in "numbers only" format (without any separators, brackets, and so on) to send an SMS invitation to. For example, 79991234567. Omitted if the Email parameter is specified. |
No |
|
|
string |
Email address to send an email to. Omitted if the Phone parameter is specified. |
No |
Response
Response structure in JSON format:
{
"result": {
"PassportOrganizationLogin": (string),
"Warnings": [{
"Code": (int),
"Message": (string),
"Details": (string)
}, ... ],
"Errors": [{
"Code": (int),
"Message": (string),
"Details": (string)
}, ... ]
}
}
|
Parameter |
Type |
Description |
|
result structure (for JSON) / AddPassportOrganizationMember (for SOAP) |
||
|
|
string |
Username of the Yandex ID organization the invite has been sent to. Alert Any user with a Yandex account can accept the invite link. |
|
|
array of ExceptionNotification |
Warnings that occurred during the operation. |
|
|
array of ExceptionNotification |
Errors that occurred during the operation. |