Skip to content
Vocapable Developers

Change a team member's role, status, or explicit human-rep link

PATCH
/v1/mobile/team/{membership_id}
curl --request PATCH \
  --url https://api.vocapable.com/v1/mobile/team/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "role": "admin", "status": "active", "human_rep_id": "example", "replace_human_rep": false }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
membership_id
required
Membership Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
TenantMembershipUpdateRequest

An admin’s explicit membership role/status or human-rep-link change.

human_rep_id is intentionally ignored unless replace_human_rep is true. This makes an omitted field different from an explicit unlink and prevents a mobile client from accidentally clearing a transfer-rep association while changing only a role.

object
role
Any of:
TenantMembershipRole

The only roles a customer can hold in one workspace.

string
Allowed values: admin manager rep
status
Any of:
string
Allowed values: active suspended revoked
human_rep_id
Any of:
string
>= 1 characters <= 128 characters
replace_human_rep
Replace Human Rep
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
TenantMembershipSummary
object
id
required
Id
string
tenant_id
required
Tenant Id
string
account_id
required
Account Id
string
display_name
Any of:
string
role
required
TenantMembershipRole

The only roles a customer can hold in one workspace.

string
Allowed values: admin manager rep
human_rep_id
Any of:
string
status
required
Status
string
Allowed values: active suspended revoked
sessions_valid_after
required
Sessions Valid After
string format: date-time
Example
{
  "role": "admin",
  "status": "active"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}