Add Member

Last Updated on : 2023-06-21 07:13:09download

According to the organization ID, add the basic information, permission, and role of a specified member to the organization.

API address

POST: /v1.0/iot-02/community/member

Request parameter

Description of body

Parameter nameTypeINRequiredDescription
block_idsString trueThe community IDs, separated with commas (,).
structure_idString trueThe ID of a specified organization.
educationString trueThe education background.
role_idsString trueThe list of role IDs, separated with commas (,).
adminInteger falseIndicates whether the member is an administrator. Valid values:
  • 1: yes.
  • 2: no.
data_permissionInteger falseThe permission to view data privacy. Valid values:
  • 1: open.
  • 2: confidential.
country_codeString falseThe country/region code. 86: China.
admin_nameString trueThe name.
sexInteger trueThe gender. Valid values:
  • 1: male.
  • 2: female.
mobileString trueThe mobile phone number.
card_typeInteger falseThe type of certificate. 1: identity card.
card_noString falseThe certificate number.
birthdayLong falseThe birthday.
positionString falseThe job position.

Return parameter

Parameter nameTypeDescription
resultStringThe ID of a specified member.

Request example

POST: /v1.0/iot-02/community/member
  "admin_name": "Utilities Operation and Maintenance",
  "role_infos": [],
  "mobile": "1300000****",
  "blocks": "136767399153950xxxx",
  "account_status": 1,
  "structure_id": "136767399153950xxxx",
  "structure_name": "test",
  "sex": 1,
  "myself": 2,
  "admin": 0,
  "country_code": "86",
  "structure_path_name": "test",
  "role_ids": "136767399153950xxxx,136767399153950xxxx",
  "card_type": 1,
  "card_no": "31162119920918xxxx",
  "birthday": 0,
  "position": "Plumber",
  "education": "Primary School"

Return example


Error code

For more information, see error code.