members.dev
Docs
Members

Update Member

Updates a Member

PATCH
/v1/members/{member_id}

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Path Parameters

member_id*string

Header Parameters

Members-Context?string

Members organization id (org_…) when the client has multiple organizations.

Default""

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://api.members.dev/v1/members/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "member_01KKSMB47VYGW97GFE67VGDK7M",
  "short_id": "XF42",
  "name": "John Doe",
  "external_id": "ext_abc123",
  "email": "string",
  "email_verified": false,
  "phone": {
    "number": "string",
    "country_code": "string"
  },
  "address": {
    "address_line_1": "string",
    "address_line_2": "string",
    "city": "string",
    "administrative_area": "string",
    "postal_code": "string",
    "country_code": "NZ"
  },
  "subscriptions": [
    {
      "id": "string",
      "product": {
        "product_id": "string"
      }
    }
  ],
  "group_ids": [
    "string"
  ],
  "custom_fields": {},
  "account_id": "string",
  "status": "draft",
  "archived_at": {},
  "pass": {
    "id": "string",
    "share_url": "string"
  },
  "created_at": null,
  "updated_at": null
}
{
  "type": "https://api.members.dev/errors/invalid_credentials",
  "title": "Invalid credentials",
  "status": 401,
  "detail": "Invalid API Key or token.",
  "code": "invalid_credentials"
}
{
  "type": "https://api.members.dev/errors/not_linked_to_tenant",
  "title": "Not linked to tenant",
  "status": 403,
  "detail": "Not linked to this tenant",
  "code": "not_linked_to_tenant"
}
{
  "type": "https://api.members.dev/errors/member_not_found",
  "title": "Member not found",
  "status": 404,
  "detail": "No member exists with the given id in this organization.",
  "code": "member_not_found"
}
{
  "type": "https://api.members.dev/errors/members_context_required",
  "title": "Members context required",
  "status": 422,
  "detail": "This client has multiple organizations. Send the Members-Context header with the organization id (org_…) for this request.",
  "code": "members_context_required"
}
{
  "type": "https://api.members.dev/errors/rate_limit_exceeded",
  "title": "Rate limit exceeded",
  "status": 429,
  "detail": "Rate limit exceeded",
  "code": "rate_limit_exceeded"
}