DUduda
Members API

Update member

Updates the member's groups and/or status, and returns the updated member.

patch/api/sites/multiscreen/{site_name}/membership/members/{id}

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/membership/members/{id}
  • Auth
    HTTP basic

Path parameters

site_namestring required

The site's unique name (its ID), returned when the site is created.

idstring required

Request body

status'ACTIVE' nullable

Target member's status. Will not be updated if not provided

Example request

{
  "groups": [
    {
      "id": "15f4b3b4e-4b3b-4b3b-4b3b-4b3b4e4b3b4e"
    }
  ]
}

Response

OK

emailstring

The member's email

first_namestring

The member's first name

idstring

The member's id within the site

last_loginstring

The member's last login ISO date-time

last_namestring

The member's last name

registeredstring

The member's registered ISO date-time

status'PENDING' | 'ACTIVE' | 'UNAUTHORIZED'

The member's status:

  • PENDING: Site owner did not yet approve the member (for approval-based membership), the member will not have access to any protected site pages
  • ACTIVE: Membership is approved, the member has some access to protected site pages
  • UNAUTHORIZED: Indicates that members count limit was reached for the site, the member will not have access to any protected site pages

Example response

{
  "email": "john.doe@example.com",
  "first_name": "John",
  "groups": [
    {
      "id": "15f4b3b4e-4b3b-4b3b-4b3b-4b3b4e4b3b4e",
      "name": "Premium users"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_login": "2024-08-01T00:00:00Z",
  "last_name": "Doe",
  "registered": "2024-08-01T00:00:00Z",
  "status": "ACTIVE"
}

Changes

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