Skip to main content
PATCH
/
api
/
v1
/
members
/
{id}
curl -X PATCH "https://api.usegately.com/api/v1/members/mem_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "John Smith",
    "plan_id": "plan_enterprise",
    "metadata": {
      "upgraded_at": "2024-01-20"
    }
  }'

{
  "success": true,
  "data": {
    "id": "mem_abc123",
    "email": "john@example.com",
    "full_name": "John Smith",
    "status": "active",
    "plan_id": "plan_enterprise",
    "metadata": {
      "company": "Acme Inc",
      "upgraded_at": "2024-01-20"
    },
    "updated_at": "2024-01-20T16:00:00Z"
  }
}

​
Path Parameters

​
id
string
required
The member’s unique identifier

​
Request Body

​
email
string
Update the member’s email address
​
full_name
string
Update the member’s full name
​
avatar_url
string
Update the member’s avatar URL
​
plan_id
string
Change the member’s plan
​
status
string
Update status: active, inactive, pending
​
metadata
object
Update custom metadata (merged with existing)

​
Response

​
success
boolean
Whether the request was successful
​
data
object
The updated member object
curl -X PATCH "https://api.usegately.com/api/v1/members/mem_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "John Smith",
    "plan_id": "plan_enterprise",
    "metadata": {
      "upgraded_at": "2024-01-20"
    }
  }'

{
  "success": true,
  "data": {
    "id": "mem_abc123",
    "email": "john@example.com",
    "full_name": "John Smith",
    "status": "active",
    "plan_id": "plan_enterprise",
    "metadata": {
      "company": "Acme Inc",
      "upgraded_at": "2024-01-20"
    },
    "updated_at": "2024-01-20T16:00:00Z"
  }
}

​
Notes

  • Only provided fields will be updated
  • Metadata is merged with existing metadata (use null to remove a key)
  • Changing email will require re-verification if email confirmation is enabled
  • Plan changes take effect immediately