Create a client

curl --request POST \
  --url https://api.assembly.com/v1/clients \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "email": "jane@example.com",
  "familyName": "Doe",
  "givenName": "Jane",
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "customFields": {}
}
'

import requests

url = "https://api.assembly.com/v1/clients"

payload = {
    "email": "jane@example.com",
    "familyName": "Doe",
    "givenName": "Jane",
    "companyId": "550e8400-e29b-41d4-a716-446655440000",
    "customFields": {}
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'jane@example.com',
    familyName: 'Doe',
    givenName: 'Jane',
    companyId: '550e8400-e29b-41d4-a716-446655440000',
    customFields: {}
  })
};

fetch('https://api.assembly.com/v1/clients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.assembly.com/v1/clients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jane@example.com',
    'familyName' => 'Doe',
    'givenName' => 'Jane',
    'companyId' => '550e8400-e29b-41d4-a716-446655440000',
    'customFields' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.assembly.com/v1/clients"

	payload := strings.NewReader("{\n  \"email\": \"jane@example.com\",\n  \"familyName\": \"Doe\",\n  \"givenName\": \"Jane\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"customFields\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.assembly.com/v1/clients")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jane@example.com\",\n  \"familyName\": \"Doe\",\n  \"givenName\": \"Jane\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"customFields\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.assembly.com/v1/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jane@example.com\",\n  \"familyName\": \"Doe\",\n  \"givenName\": \"Jane\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"customFields\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "avatarImageUrl": "https://portal.example.com/avatars/alex.png",
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "companyIds": [
    "<string>"
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "creationMethod": "client",
  "customFields": {},
  "deleted": true,
  "email": "alex.morgan@example.com",
  "fallbackColor": "#4F46E5",
  "familyName": "Morgan",
  "firstLoginDate": "2024-01-15T09:30:00Z",
  "givenName": "Alex",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "inviteUrl": "https://portal.example.com/invite/abc123",
  "invitedBy": "550e8400-e29b-41d4-a716-446655440001",
  "lastLoginDate": "2024-02-20T14:05:00Z",
  "status": "active",
  "updatedAt": "2024-02-20T14:05:00Z"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

POST

clients

Create a client

curl --request POST \
  --url https://api.assembly.com/v1/clients \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "email": "jane@example.com",
  "familyName": "Doe",
  "givenName": "Jane",
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "customFields": {}
}
'

import requests

url = "https://api.assembly.com/v1/clients"

payload = {
    "email": "jane@example.com",
    "familyName": "Doe",
    "givenName": "Jane",
    "companyId": "550e8400-e29b-41d4-a716-446655440000",
    "customFields": {}
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'jane@example.com',
    familyName: 'Doe',
    givenName: 'Jane',
    companyId: '550e8400-e29b-41d4-a716-446655440000',
    customFields: {}
  })
};

fetch('https://api.assembly.com/v1/clients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.assembly.com/v1/clients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jane@example.com',
    'familyName' => 'Doe',
    'givenName' => 'Jane',
    'companyId' => '550e8400-e29b-41d4-a716-446655440000',
    'customFields' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.assembly.com/v1/clients"

	payload := strings.NewReader("{\n  \"email\": \"jane@example.com\",\n  \"familyName\": \"Doe\",\n  \"givenName\": \"Jane\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"customFields\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.assembly.com/v1/clients")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jane@example.com\",\n  \"familyName\": \"Doe\",\n  \"givenName\": \"Jane\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"customFields\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.assembly.com/v1/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jane@example.com\",\n  \"familyName\": \"Doe\",\n  \"givenName\": \"Jane\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"customFields\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "avatarImageUrl": "https://portal.example.com/avatars/alex.png",
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "companyIds": [
    "<string>"
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "creationMethod": "client",
  "customFields": {},
  "deleted": true,
  "email": "alex.morgan@example.com",
  "fallbackColor": "#4F46E5",
  "familyName": "Morgan",
  "firstLoginDate": "2024-01-15T09:30:00Z",
  "givenName": "Alex",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "inviteUrl": "https://portal.example.com/invite/abc123",
  "invitedBy": "550e8400-e29b-41d4-a716-446655440001",
  "lastLoginDate": "2024-02-20T14:05:00Z",
  "status": "active",
  "updatedAt": "2024-02-20T14:05:00Z"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

{
  "code": "<string>",
  "data": "<unknown>",
  "message": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

sendInvite

boolean

Send the client an invite email on creation

Body

application/json

Client to create

string<email>

required

Email is the client's email address.

Example:

"jane@example.com"

familyName

string

required

FamilyName is the client's last name.

Example:

"Doe"

givenName

string

required

GivenName is the client's first name.

Example:

"Jane"

companyId

string<uuid>

CompanyID associates the client with a single company.

Example:

"550e8400-e29b-41d4-a716-446655440000"

customFields

object

CustomFields holds custom field values keyed by custom field key.

Show child attributes

Response

avatarImageUrl

string<uri>

AvatarImageUrl is the URL of the client's avatar image. Read-only.

Example:

"https://portal.example.com/avatars/alex.png"

companyId

string<uuid>

CompanyID is the ID of the company the client belongs to. In multi-company portals see companyIds.

Example:

"550e8400-e29b-41d4-a716-446655440000"

companyIds

string[]

CompanyIDs lists every company the client belongs to in multi-company portals.

createdAt

string<date-time>

Created is the RFC 3339 timestamp at which the object was created.

Example:

"2024-01-15T09:30:00Z"

creationMethod

enum<string>

CreationMethod records how the client was created. Read-only.

Available options:

client,

directSignUp,

import,

internalUser

Example:

"client"

customFields

object

CustomFields holds custom field values for the client, keyed by custom field key.

Show child attributes

deleted

boolean

Deleted is true when the object has been deleted; present only on delete responses.

Example:

true

string<email>

Email is the client's email address, used as the unique login identifier within the portal.

Example:

"alex.morgan@example.com"

fallbackColor

string

FallbackColor is the hex color (e.g. "#4F46E5") used as the avatar background when no avatar image is set. The native pattern documents intent; the constraint is re-applied to the spec by the enrich-openapi post-processing step.

Pattern: ^#[0-9a-fA-F]{6}$

Example:

"#4F46E5"

familyName

string

FamilyName is the client's last (family) name.

Example:

"Morgan"

FirstLogin is the timestamp of the client's first login. Read-only.

Example:

"2024-01-15T09:30:00Z"

givenName

string

GivenName is the client's first (given) name.

Example:

"Alex"

string

ID is the unique identifier of the object.

Example:

"550e8400-e29b-41d4-a716-446655440000"

inviteUrl

string<uri>

InviteUrl is the one-time invite link, returned only when an invite has just been sent. Read-only.

Example:

"https://portal.example.com/invite/abc123"

invitedBy

string

InvitedBy is the ID of the internal user who invited the client, when applicable. Read-only.

Example:

"550e8400-e29b-41d4-a716-446655440001"

LastLogin is the timestamp of the client's most recent login. Read-only.

Example:

"2024-02-20T14:05:00Z"

object

enum<string>

Object is the type of the object (e.g. "client", "company").

Available options:

client,

internalUser,

company,

customField,

customFieldOption,

file,

fileChannel,

folder,

messageChannel,

message,

notification

status

enum<string>

Status is the client's lifecycle status. Server-managed (read-only).

Available options:

unknown,

deleted,

active,

notInvited,

invited

Example:

"active"

updatedAt

string<date-time>

Updated is the RFC 3339 timestamp at which the object was last updated.

Example:

"2024-02-20T14:05:00Z"

Clients List clients

⌘I

Getting started

Webhooks

Core Resources

CRM

Messaging

Billing

Files

Contracts

Forms

Tasks

Token

Others

Create a client

Authorizations

Query Parameters

Body

Response