Skip to content
/
Update team member access

Update team member access

Request

Merge-patch access settings. Only role_id is mutable; unavailable roles fail with 422 role_not_assignable. Requires If-Match with the ETag from getTeamMemberAccess (or a prior successful write).

Security
OAuth2(Required scopes: team_members:manage_access)
Path
location_idintegerrequired

Identifier of the Location. Verified against the credential on every call — a Location the credential cannot access responds with 404.

team_member_idintegerrequired

Identifier of the Team Member.

Headers
If-Matchstringrequired

ETag value of the resource version the change is based on. A stale value fails with 412 stale_version; a missing header fails with 428 precondition_required.

Bodyapplication/merge-patch+jsonrequired
role_idintegerrequired
curl -i -X PATCH \
  'https://developer.alteg.io/_mock/en/b2b-v3/openapi/locations/{location_id}/team_members/{team_member_id}/access' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -H 'If-Match: string' \
  -d '{
    "role_id": 7
  }'

Responses

OK

Headers
RateLimit-Remaininginteger, (int32), >= 0

Requests left in the most constrained policy window that applies to this request.

RateLimit-Resetinteger, (int32), >= 0

On 429, seconds until the most constrained policy frees up; it equals Retry-After there. On a successful response it reports the length of that policy's window rather than the time left in the current one, so treat it as the window size, not as a countdown — the counter to pace against is RateLimit-Remaining.

RateLimit-Policystring

Most constrained policy applied to the request, as <limit>;w=<window in seconds>.

Example:"10;w=60"
ETagstring

Version tag of the returned resource. Send it back in If-Match on the next PATCH or DELETE.

X-Request-Idstring

Request identifier for support and log correlation.

Bodyapplication/json
objectstringrequired
Value:"team_member_access"
team_member_idintegerrequired
statusstringrequired
Enum:"none""invited""active"
role_idinteger or nullrequired
invitationTeamMemberAccessInvitation (object) or null
One of:
Response
{
  "object": "team_member_access",
  "team_member_id": 0,
  "status": "none",
  "role_id": 0,
  "invitation": {
    "sent_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z"
  }
}