| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

# Notes:   [Skip link to Notes:](https://docs.assembly.com/reference/create-company#notes)

**Custom Fields**

When creating a company with custom field values, the `customFields` object will have keys that correspond to the `key` entity of the [Custom Field](https://docs.copilot.com/reference/custom-fields), and values that are either strings, numbers, arrays of strings (in the case of a `multiSelect` type custom field), or an object (in the case of an `address` custom field). For `multiSelect` custom fields, the values in the array will correspond to the `key` entity of the [Custom Field Option](https://docs.copilot.com/reference/custom-field-options).

For example, if you have 2 custom fields: one named `Services` of type `multiSelect` (with key `services`), and one named `Pronouns` of type `text` (with key `pronouns`), matching the [Custom Field Object example](https://docs.copilot.com/reference/custom-fields), when creating a client, your request body might include a `customFields` parameter that looks like this:

JSON

```json
{
    "customFields": {
        "services": [
            "fileSharing",
            "metrics"
        ],
        "pronouns": "She/Her/Hers",
        "phoneNumber": "+14441234576",
        "address": {
            "country": "US",
            "region": "New York",
            "postalCode": "10001",
            "addressLine1": "1201 Broadway",
            "addressLine2": "704",
            "city": "New York",
            "fullAddress": "1201 Broadway\n704\nNew York, New York, 10001\nUnited States"
        }
    }
}
```

**Custom Fields: Phone Number**

When creating a client with a custom field of type `phoneNumber`, the format needed for the value of that custom field for a successful update is `+{countryCode}{areaCode}{number}`

Example: `+12123456789`

The `countryCode` and `areaCode` must be valid to be updated successfully.

**Custom Fields: Address**

When creating a client with a custom field of type `address` , provide an that matches the schema below. Fields annotated with a question mark are optional, but can be filled out if your `country` is `US`, `CA`, `AU`, `GB`, or `NZ`. `country` must be a two character country code.

JSON

```json
{
	fullAddress: string,
	country: string,
	region?: string,
	postalCode?: string,
	addressLine1?: string,
	addressLine2?: string,
	city?: string,
}
```

To avoid breaking changes with existing integrations with our Platform API, the API will also accept a string rather than an object. In these instances, the API will convert the string to an object, and set the full address as the provided string.

name

string

required

The company's name

iconImageUrl

string

Link (URL) to an image to use as the company's icon. Must be a publicly accessible URL.

fallbackColor

string

Hexadecimal value (i.e. "#9BBFFF") of the color used to create an icon if an iconImageUrl is not defined on the company

customFields

json

The keys are the key of the custom field property, and the values are an array of custom field option keys (in the case of multiSelect custom fields), or the direct value in the case of all other types of custom fields.