Members

Invite workspace member

Changed on
post/v2/workspaces/{workspace_id}/members

Request

  • Base URL: https://api.app.layer.ai/api
  • URL: https://api.app.layer.ai/api/v2/workspaces/{workspace_id}/members
  • Auth: HTTP bearer

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Headers

Idempotency-Keystring

Opaque key making a retry of this request return the first result. A 2xx response is replayed for 24 hours with Idempotent-Replayed: true. A 4xx releases the key. A 5xx, or a request still running, holds the key for 120 seconds, during which a retry gets 409; after that a retry executes again. The key covers the method, path, query, and byte-identical body it was first used with; reusing it for a different request is rejected with 422. Protection is best effort: if the key store is unavailable, or a record is lost early, a retry can execute again even after an earlier 409. See the Idempotency section of the API description.

Request body

emailstring email required

Email of the person to invite. A Layer user is created if none exists.

role'admin' | 'editor' | 'settings_admin' | 'art_director' | 'artist' | 'creator' | 'member' | 'installation' | 'provisioning'

Response

Successful Response

membership_idstring uuid required

The workspace membership's unique identifier.

principal_idstring uuid required

The member's principal id: for a person, the same as their user id.

user_idstring uuid required

The member's user id. Deprecated: use principal_id.

emailstring required

The member's email address.

namestring nullable

The member's display name, if set.

role'admin' | 'editor' | 'settings_admin' | 'art_director' | 'artist' | 'creator' | 'member' | 'installation' | 'provisioning' required
status'active' | 'suspended' required

Changes

  • 326f3bcdabccRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • a98f20230c3fRevision changes
    • info

      response property user_id deprecated

    • info

      added the required property to the response with the status