Members

Add account member

Changed on

Add a new member to the account. There are three ways:

  • Email invitation — pass email only. An invitation is sent; the recipient accepts it from the dashboard. The member appears in pending status until accepted. Equivalent to calling POST /api/v1/invitations directly.
  • Direct add — pass target_user_id for a user who already has an account on Raff (e.g. a project-only user being promoted to account member).
  • API key — pass api_key_id to make an existing API key a member with the given role. Mutually exclusive with email and target_user_id.
post/api/v1/members

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/members
  • Auth
    API key in header X-API-Key

Request body

emailstring email

Email to invite. Mutually exclusive with target_user_id and api_key_id.

target_user_idstring uuid

User UUID to add directly. The user must already exist on Raff (e.g. an existing project-only member). Mutually exclusive with email and api_key_id.

api_key_idstring uuid

API key UUID to grant account-level access via this membership. Mutually exclusive with email and target_user_id.

role_idstring uuid

Role UUID. Required.

Response

Member added (or invitation sent)

successboolean

Example response

{
  "data": {
    "role_name": "Operator"
  }
}

Changes