Skip to main content
POST
/
api
/
customers
Create Customer
curl --request POST \
  --url https://api.rapidly.tech/api/customers/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "metadata": {},
  "external_id": "usr_1337",
  "name": "John Doe",
  "billing_address": {
    "country": "AD",
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>"
  },
  "type": "individual",
  "workspace_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "owner": {
    "email": "member@example.com",
    "name": "Jane Doe",
    "external_id": "usr_1337"
  }
}
'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "external_id": "usr_1337",
  "email": "<string>",
  "email_verified": true,
  "name": "John Doe",
  "billing_address": {
    "country": "AD",
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>"
  },
  "workspace_id": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "avatar_url": "<string>",
  "type": "individual",
  "members": [
    {
      "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",
      "role": "owner"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Create an Workspace Access Token in your workspace's settings page.

Body

application/json
​
email
string<email>
required

The email address of the customer. This must be unique within the workspace.

Example:

"customer@example.com"

​
metadata
Metadata · object

Custom key-value attributes.

Keys: string, max 40 chars. Values: string (max 500 chars), integer, float, or boolean. Limit: 50 pairs.

​
external_id
string | null

The ID of the customer in your system. This must be unique within the workspace. Once set, it can't be updated.

Example:

"usr_1337"

​
name
string | null

The name of the customer.

Maximum string length: 256
Example:

"John Doe"

​
billing_address
AddressInput · object
​
type
enum<string> | null

The type of customer. Defaults to 'individual'. Set to 'team' for customers that can have multiple members.

Available options:
individual,
team
Example:

"individual"

​
workspace_id
string<uuid4> | null

The workspace ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

​
owner
OwnerCreate · object

Optional owner member to create with the customer. If not provided, an owner member will be automatically created using the customer's email and name.

Response

Customer created.

A customer in an workspace with their members loaded.

​
id
string<uuid4>
required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
metadata
object
required
​
external_id
string | null
required

The ID of the customer in your system. This must be unique within the workspace. Once set, it can't be updated.

Example:

"usr_1337"

​
email
string
required

The email address of the customer. This must be unique within the workspace.

Example:

"customer@example.com"

​
email_verified
boolean
required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

Example:

true

​
name
string | null
required

The name of the customer.

Example:

"John Doe"

​
billing_address
Address · object
required

A postal address with optional subdivision (state/province) validation.

​
workspace_id
string<uuid4>
required

The ID of the workspace owning the customer.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

​
deleted_at
string<date-time> | null
required

Timestamp for when the customer was soft deleted.

​
avatar_url
string
required
Example:

"https://www.gravatar.com/avatar/xxx?d=404"

​
type
enum<string> | null

The type of customer: 'individual' for single users, 'team' for customers with multiple members. Legacy customers may have NULL type which is treated as 'individual'.

Available options:
individual,
team
Example:

"individual"

​
members
Member · object[]

List of members belonging to this customer.