Authorization

HTTPBearer

AuthorizationBearer <token>

In: header

Path Parameters

member_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|

Member display name.

emails?array<>|

When set (including empty list), sync emails. First item is the default.

addresses?array<>|

When set (including empty list), sync addresses. First item is the default.

phones?array<>|

When set (including empty list), sync phones. First item is the default.

custom_fields?|

When set, replaces portal-editable custom field values. Send an empty object to clear.

Response Body

`application/json`

curl -X PATCH "https://api.members.dev/portal/v1/members/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "short_id": "string",
  "name": "string",
  "status": "draft",
  "emails": [
    {
      "id": "member_email_01KKSMB47VYGW97GFE67VGDK7M",
      "email": "user@example.com",
      "is_default": true,
      "is_verified": true
    }
  ],
  "addresses": [
    {
      "id": "member_address_01KKSMB47VYGW97GFE67VGDK7M",
      "recipient_name": "string",
      "address_line_1": "string",
      "address_line_2": "string",
      "city": "string",
      "administrative_area": "string",
      "postal_code": "string",
      "country_code": "string",
      "is_default": true
    }
  ],
  "phones": [
    {
      "id": "member_phone_01KKSMB47VYGW97GFE67VGDK7M",
      "number": "string",
      "country_code": "string",
      "is_default": true
    }
  ],
  "group_ids": [
    "string"
  ],
  "custom_fields": {},
  "pass": {
    "id": "string",
    "share_url": "string"
  },
  "created_at": null,
  "updated_at": null
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update Member

Authorization

Path Parameters

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`