Update a member

PATCH /api/v1/admin/members/{memberId}

Reference for PATCH /api/v1/admin/members/{memberId}.

Authentication

Pass an administrator member session or an API key as a bearer token. An API key must include the administrative capability named in the endpoint description.

Remote administrative requests require HTTPS. Requests from the local computer can use HTTP.

Request

curl 'http://localhost:8977/api/v1/admin/members/memberId_123' \
  -X PATCH \
  -H "Authorization: Bearer $FLUXMAIL_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{}'

Parameters

Name	Location	Required	Type	Details
`memberId`	path	Yes	`string`	Minimum length: 1.

Request body

Content type: application/json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "member"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "suspended"
      ]
    }
  },
  "additionalProperties": false
}

Responses

Status	Description	Content type
`200`	Success	`application/json`
`400`	Invalid request	`application/json`
`401`	Authentication required	`application/json`
`403`	Permission denied	`application/json`
`404`	Not found	`application/json`
`409`	Conflict	`application/json`
`413`	Request body too large	`application/json`
`429`	Too many attempts	`application/json`

200 response

{
  "type": "object",
  "properties": {
    "data": {
      "nullable": true
    }
  }
}