Skip to content
/
New Brands

New Brands

Request

Create one or more new Brand records in the User's own Organization. Only Brands without domains can be manually created, and only in the User's own Organization (not Contact Organizations), and these can be assigned only to Projects, not Persons (i.e. Email Addresses).

The operation can only be performed by one of your organization's TonicDM Administrators.

NOT YET IMPLEMENTED

Security
OAuth2(Required scopes: readwrite)
Bodyapplication/json
Array [
statusstring(Status)

Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.

Default:"active"
Enum:"active""inactive""deleted"
domainsArray of strings

Currently one and only one domain must be present.

Zero or more domains that belong to this organization and represent the Brand, eg. firm.com, firm.co.us.

In the case of a shared domain contact, the "domain" of their Brand is their full email address, eg. steven.novosel@gmail.com.

brandNameLegalstring, <= 128 characters

The full official name of the Brand (used on transmittals).

brandNameKnownAsstring, <= 128 characters

The friendly name of the Brand (used within the TonicDM app).

brandInitialsstring, <= 4 characters

The initials of the Brand (used in very small spaces)

brandColorstring, (hex)^(?:[0-9a-fA-F]{6}|)$

Brand color for the Brand.

disciplinesArray of strings

limits the disciplines that can be chosen for any person in this Brand to help consistency.

certificationsArray of strings

Zero or more certifications that this Brand has obtained, or previously obtained, for example Women Owned Business. REQUIRES the TonicDM AdvancedContacts license. REQUIRES the TonicDM AdvancedContacts license.

organizationIdstring(CompactUUID)^[0-9a-fA-F]{32}$

A UUID used to link multiple Brand records together into an organization. There are no extra fields associated with this UUID. It serves only as a linking mechanism. REQUIRES the TonicDM AdvancedContacts license.

Example:"8e8aa42241794371ae9d0ed7b67a8c86"
isPrimeboolean

Indicates that this Brand is the primary Brand for this organization. When displaying an organization, the Prime Brand info will be used for their Name, etc. REQUIRES the TonicDM AdvancedContacts license.

customerDataWarehouseIdstring

The ID of the Person in the Customer's Data Warehouse.

FOR USE BY CUSTOMER. NOT YET IMPLEMENTED. REQUIRES the TonicDM AdvancedMetrics license.

customerErpIdstring

The ID of the Person in the Customer's ERP system (eg. Deltek Vantagepoint).

FOR USE BY CUSTOMER. NOT YET IMPLEMENTED. REQUIRES the TonicDM AdvancedMetrics license.

customerCrmIdstring

The ID of the Person in the Customer's CRM system (eg. Deltek Salesforce).

FOR USE BY CUSTOMER. NOT YET IMPLEMENTED. REQUIRES the TonicDM AdvancedMetrics license.

]
curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/brands/insert \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "nameLong": "Pacific Brand Design Company",
    "nameShort": "Pacific Brands",
    "nameInitials": "PBDC",
    "brandColor": 800080
  }'

Responses

Successfully created the resource you sent

Bodyapplication/json
statusstringrequired
Value:"success"
dataArray of objects, = 1 items(Brand)required
metadataobject(ResponseMetadata)required

Present on every JSON response. For non-paginated operations, page will be 1, total_pages will be 1, and total_records equal to the number of elements in data.

Response
{
  "id": "73d70530df944cd38b448822aa1d94b6",
  "datetimeCreated": "2021-11-03T16:21:02+00:00",
  "datetimeUpdated": "2024-04-20T16:21:02+00:00",
  "status": "active",
  "nameLong": "Pacific Brand Design Company",
  "nameShort": "Pacific Brands",
  "nameInitials": "PBDC",
  "brandColor": 800080,
  "organizationId": "f3efcad7082d4e85ae2741a57629b323"
}