HAhappyscribe
Members

Update a member

Changes the member's name. The member's policy changes through PATCH /policies/{id}.

patch/members/{id}

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Request body

namestring

The member's new name.

Response

The updated member.

idstring

Stable typed member ID beginning with mem_. Treat it as an opaque string.

objectstring

Always member.

workspace_idstring

Workspace ID, beginning with wks_. Treat it as an opaque string.

emailstring email

The member's email, unique within the workspace.

namestring nullable

null for a person who also has workspaces of their own: their name is theirs.

metadataMetadata

Your own key-value pairs, for your ids and context. HappyScribe stores them, returns them on the object and in every webhook that carries it, and never acts on them. Up to 50 keys of up to 40 characters (no square brackets), values up to 500 characters. See metadata.

created_atstring date-time

When the member was created, in ISO 8601.

Example response

{
  "workspace_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
  "metadata": {
    "gurusup_user_id": "usr_8812"
  }
}

Changes

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