POpolar
customer_portal
members
public

Add Member

Add a new member to the customer's team.

Only available to owners and billing managers of team customers.

Rules:

  • Cannot add a member with the owner role (there must be exactly one owner)
  • If a member with this email already exists, the existing member is returned
post/v1/customer-portal/members

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customer-portal/members
  • Auth
    HTTP bearer

Request body

emailstring email required

The email address of the new member.

namestring nullable

The name of the new member (optional).

role'owner' | 'billing_manager' | 'member'

Response

Member added.

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

idstring uuid4 required

The ID of the object.

emailstring required

The email address of the member.

namestring nullable required

The name of the member.

role'owner' | 'billing_manager' | 'member' required

Changes

No recorded changes to this operation across all 11 revisions of this API.