Skip to main content
PATCH
/
v1
/
members
/
external
/
{external_id}
Python (SDK)
from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.members.update_member_by_external_id(external_id="<id>", member_update={
        "name": "Jane Doe",
    })

    # Handle response
    print(res)
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "email": "<string>",
  "name": "Jane Doe",
  "external_id": "usr_1337"
}

Documentation Index

Fetch the complete documentation index at: https://polar-dependabot-npm-and-yarn-docs-openapi-sampler-1-7-3.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

​
external_id
string
required

The member external ID.

Query Parameters

​
customer_id
string<uuid> | null

The customer ID.

​
external_customer_id
string | null

The customer external ID.

Body

application/json

Schema for updating a member.

​
name
string | null

The name of the member.

Maximum string length: 256
Example:

"Jane Doe"

​
role
enum<string> | null

The role of the member within the customer.

Available options:
owner,
billing_manager,
member
Example:

"member"

Response

Member updated.

A member of a customer.

​
id
string<uuid4>
required

The ID of the member.

​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
customer_id
string<uuid4>
required

The ID of the customer this member belongs to.

​
email
string
required

The email address of the member.

Example:

"member@example.com"

​
name
string | null
required

The name of the member.

Example:

"Jane Doe"

​
external_id
string | null
required

The ID of the member in your system. This must be unique within the customer.

Example:

"usr_1337"

​
role
enum<string>
required

The role of the member within the customer.

Available options:
owner,
billing_manager,
member
Example:

"owner"