Update Member

Update a member.

Only name and role can be updated. The authenticated user or organization must have access to the member’s organization.

Scopes: members:write

PATCH /v1/members/{id}

Go (SDK)

Go

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Members.UpdateMember(ctx, "ab9b628a-6dbd-4f07-bcd6-163a8b5b7de4", components.MemberUpdate{
        Name: polargo.Pointer("Jane Doe"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Member != nil {
        // handle response
    }
}

200

{
  "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"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string<uuid> · required

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

200

application/json

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:

"[e-mail]"

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"