Create Member

Create a new member for a customer.

Only B2B customers with the member management feature enabled can add members. The authenticated user or organization must have access to the customer’s organization.

Scopes: members:write

POST /v1/members

Create Member

cURL

curl --request POST \
  --url https://api.spairehq.com/v1/members/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<string>",
  "email": "[e-mail]",
  "name": "Jane Doe",
  "external_id": "usr_1337",
  "role": "member"
}
'

201

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

patoat

Authorization · string · header · required

You can generate a Personal Access Token from your settings.

Body

application/json

Schema for creating a new member.

customer_id · string<uuid4> · required

The ID of the customer this member belongs to.

email · string<email> · required

The email address of the member.

Example:

"[e-mail]"

name · string | null

The name of the member.

Maximum string length: 256

Example:

"Jane Doe"

external_id · string | null

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

Example:

"usr_1337"

role · enum<string> · default: member

The role of the member within the customer.

Available options: owner, billing_manager, member

Example:

"member"

Response

201

application/json

Member created.

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"