Skip to main content
POST
/
api
/
company
/
child
Create Child Company
curl --request POST \
  --url https://app.replay.sale/api/company/child \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Acme Corp - North Division",
  "externalId": "clp-customer-12345",
  "url": "https://acme.example.com",
  "summary": "North America sales division."
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Corp - North Division",
  "parentCompanyId": "11111111-1111-1111-1111-111111111111",
  "externalId": "clp-customer-12345",
  "createdAt": "2026-05-11T12:00:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.replay.sale/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from your company settings.

Body

application/json
​
name
string
required

Human-readable name for the new child company. Must be unique across all companies.

Required string length: 1 - 255
Example:

"Acme Corp - North Division"

​
externalId
string

Caller-supplied identifier (e.g., the customer's ID in your own system). When provided, retrying this endpoint with the same externalId returns the existing child instead of creating a duplicate. Unique per parent company.

Required string length: 1 - 255
Example:

"clp-customer-12345"

​
url
string<uri>

Optional homepage URL for the child company.

Example:

"https://acme.example.com"

​
summary
string

Optional short description of the child company.

Maximum string length: 2000
Example:

"North America sales division."

Response

Child company created (or existing child returned on idempotent retry).

​
id
string<uuid>
required

Unique identifier for the child company.

Example:

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

​
name
string
required

Name of the child company.

Example:

"Acme Corp - North Division"

​
parentCompanyId
string<uuid>
required

ID of the parent company (the authenticated caller).

Example:

"11111111-1111-1111-1111-111111111111"

​
externalId
string | null
required

Caller-supplied identifier echoed back. null if the child was created without one.

Example:

"clp-customer-12345"

​
createdAt
string<date-time>
required

When the child company was created.

Example:

"2026-05-11T12:00:00.000Z"