Update a member

PATCH

https://{your_space_name}.signalwire.com/api/space/members/:id

Changes a member’s name, role, or job title. PUT is accepted on the same path with identical semantics.

The owner’s role cannot be changed (cannot_change_the_owners_role), and owner cannot be assigned to anyone else.

Permissions

Authenticate with a Personal access token whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder’s role in the space is the whole authorization decision.

Changes a member's name, role, or job title. `PUT` is accepted on the same path with identical semantics. The owner's role cannot be changed (`cannot_change_the_owners_role`), and `owner` cannot be assigned to anyone else. #### Permissions Authenticate with a [Personal access token](/docs/apis/authorization#personal-access-tokens) whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder's role in the space is the whole authorization decision.

Authentication

AuthorizationBasic

Personal access token authentication for space-wide administration.

Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project’s: it is created from your user menu in the Dashboard, is prefixed pat_, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space.

Example:

Authorization: Basic base64(:pat_...)

Personal access token authentication for space-wide administration. Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project's: it is created from your user menu in the Dashboard, is prefixed `pat_`, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space. Example: ``` Authorization: Basic base64(:pat_...) ```

Path parameters

idstringRequiredformat: "uuid"

The unique identifier of the membership.

Request

This endpoint expects an object.

namestringRequired

The member's name.

roleenumOptional

The role to assign: admin or employee. The owner’s role cannot be changed (cannot_change_the_owners_role).

job_titleenumOptional

The member's job title.

Response

The request has succeeded.

typeenum

The object type. Always member.

idstringformat: "uuid"

The unique identifier of the membership, used in the path of the member endpoints.

emailstring

The member's email address.

namestring or null

The member’s name, or null when none was given.

roleenum

The member's role in the space.

job_titleenum or null

The member’s job title, or null when not set.

activatedboolean

Whether the member has accepted the invitation. false until the invitation is accepted.

last_logged_indatetime or null

The date and time the member last signed in, or null if they never have.

created_atdatetime

The date and time when the membership was created.

updated_atdatetime

The date and time when the membership was last updated.

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error