Sign in

v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB
Teams

Change Team Member Role

Change a team member's organization role and/or their role on one or more WhatsApp Business Accounts (WABA). At least one of orgRole or wabaRoles must be provided.

patch/team-member/role

Request body

memberPhoneNumberstring required

Phone number (with country code) of the team member whose roles are being changed.

Example request

{
  "memberPhoneNumber": "919999999999",
  "orgRole": {
    "roleId": "9f8b7c6d-1234-4a5b-8c9d-0e1f2a3b4c5d",
    "roleName": "Admin"
  },
  "wabaRoles": [
    {
      "wabaNumber": "911111111111",
      "roleId": "3c4d5e6f-2345-4b6c-9d0e-1f2a3b4c5d6e"
    },
    {
      "wabaNumber": "912222222222",
      "roleName": "Agent"
    }
  ]
}

Response

Resulting role state of the team member

successboolean required
memberPhoneNumberstring required

Phone number of the team member whose role was changed

orgRoleIdstring

Resulting org role id. Present only if orgRole was requested.

orgRoleNamestring

Resulting org role name. Present only if orgRole was requested.

Example response

{
  "success": true,
  "memberPhoneNumber": "919999999999",
  "orgRoleId": "9f8b7c6d-1234-4a5b-8c9d-0e1f2a3b4c5d",
  "orgRoleName": "ADMIN",
  "wabaRoles": {
    "added": [
      {
        "wabaNumber": "911111111111",
        "wabaName": "Acme Support",
        "roleId": "3c4d5e6f-2345-4b6c-9d0e-1f2a3b4c5d6e",
        "roleName": "Agent"
      }
    ],
    "errored": [
      {
        "wabaNumber": "911111111111",
        "error": "Role not found"
      }
    ]
  }
}