Sign in

v6

latestOpenAPI 3.1.02026-07-311856741.1 MB
customers
members
public

Create Member by Customer External ID

Create a new member for a customer identified by its external ID.

Scopes: members:write

post/v1/customers/external/{external_id}/members

Path parameters

external_idstring required

The customer external ID.

The customer external ID.

Request body

emailstring email required

The email address of the member.

namestring nullable

The name of the member.

external_idstring nullable

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

role'member' | 'billing_manager'

The role of the member within the customer. To assign or transfer ownership, use the member update endpoint.

Example request

{
  "email": "member@example.com",
  "name": "Jane Doe",
  "external_id": "usr_1337",
  "role": "member"
}

Response

Member created.

idstring uuid4 required

The ID of the member.

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

customer_idstring uuid4 required

The ID of the customer this member belongs to.

emailstring required

The email address of the member.

namestring nullable required

The name of the member.

external_idstring nullable required

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

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

Example response

{
  "email": "member@example.com",
  "name": "Jane Doe",
  "external_id": "usr_1337"
}