Members

Update a member

Updates a member from your team.

patch/members/{memberId}

Request

Base URL
https://api.spoke.com/public/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/spoke/apis/spoke-api/docs/members/:memberId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

memberIdstring required

The member id

Request body

namestring nullable

The member's full name

displayNamestring nullable

The name displayed for the member in the UI

role'admin' | 'depot-manager' | 'dispatcher' | 'read-only' nullable

The operational role given to the member.

depotsstring[] nullable

The depot IDs associated with the member in the format depots/<id>, duplicates will be ignored. If set to null or not provided, the team's Main depot will be set as member depot.

Response

The updated member

idstring required

namestring nullable required

The name of the member.

emailstring nullable required

The email of the member.

phonestring nullable required

The phone number of the member.

linkedDriverIdstring required

displayNamestring nullable required

The display name of the member.

activeboolean required

Whether the member membership is active or paused.

depotsstring[] required

Depots associated with the member.

rolesstring[] required

The role(s) given to the member.

Changes

No recorded changes to this operation across all 1 revision of this API.