Members

Add a member to an organization

Directly adds a user as a member of an organization. Requires manage permission (owner or admin).

post/v1beta/organizations/{organization_id}/members

Path parameters

organization_idstring required

Organization to add the member to. Pattern: org_[0-9a-hjkmnp-tv-z]{26}

Organization to add the member to. Pattern: org_[0-9a-hjkmnp-tv-z]{26}

Request body

role'owner' | 'admin' | 'member' required
user_idstring required

User account ID of the member to add. Pattern: user_[0-9a-hjkmnp-tv-z]{26}

Response

Success

Example response

{
  "member": {
    "user": {
      "id": "user_01h2xcejqtf2nbrexx3vqjhp41"
    }
  }
}

Changes

Changed in 3 of the 50 revisions of this API.28

    • ○

      api tag Members added

      api-tag-added

    • ○

      api tag Organizations removed

      api-tag-removed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ○

      the // response's property pattern was changed from ^(user|svc)_[0-9a-hjkmnp-tv-z]{26}$ to ^user_[0-9a-hjkmnp-tv-z]{26}$ for the status

      response-property-pattern-changed

    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      endpoint added

      endpoint-added