SPspoke
Members

Create a new member

Create a member with the given data in your team. Prefer using the batch import endpoint for creating multiple members at once as it is more efficient.

post/members

Request

Request body

namestring nullable

The member's full name

displayNamestring nullable

The name displayed for the member in the UI

emailstring email nullable

Member's email

linkedDriverIdstring nullable

The existing driver to link the member to

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

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 created 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.