brands

add_brand

POST

/api/v2/brands/add_brand

Code
Create a new brand

add_brand › Request Body

Request payload for /api/v2/brands/add_brand

request-add_brand

name

string · maxLength: 100 · required

Brand name

logo_file_id

string

File ID for the brand logo

signature_file_id

string

File ID for the brand signature

header_line_1

string

Header line 1

header_line_2

string

Header line 2

header_line_3

string

Header line 3

header_line_4

string

Header line 4

active

boolean

Whether the brand is active

Default: true

add_brand › Responses

200

Response payload for /api/v2/brands/add_brand

response-add_brand

required

brand-def · required

Brand definition schema

success

boolean · required

POST/api/v2/brands/add_brand

curl --request POST \
  --url /api/v2/brands/add_brand \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "logo_file_id": "logo_file_id",
  "signature_file_id": "signature_file_id",
  "header_line_1": "header_line_1",
  "header_line_2": "header_line_2",
  "header_line_3": "header_line_3",
  "header_line_4": "header_line_4",
  "active": true
}
'

Example Request Body

{
  "name": "name",
  "logo_file_id": "logo_file_id",
  "signature_file_id": "signature_file_id",
  "header_line_1": "header_line_1",
  "header_line_2": "header_line_2",
  "header_line_3": "header_line_3",
  "header_line_4": "header_line_4",
  "active": true
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "logo_file_id": "logo_file_id",
    "signature_file_id": "signature_file_id",
    "header_line_1": "header_line_1",
    "header_line_2": "header_line_2",
    "header_line_3": "header_line_3",
    "header_line_4": "header_line_4",
    "active": true,
    "date_created": "2024-08-25T15:00:00Z",
    "date_updated": "2024-08-25T15:00:00Z"
  },
  "success": true
}

json

application/json

assign_business_location

POST

/api/v2/brands/assign_business_location

Code
Assign a business location to a brand

assign_business_location › Request Body

Request payload for /api/v2/brands/assign_business_location

request-assign_business_location

brand_id

string · required

Brand identifier

location_id

string · required

Business location identifier

assign_business_location › Responses

200

Response payload for /api/v2/brands/assign_business_location

response-assign_business_location

required

brand_association-def · required

Brand association definition schema

success

boolean · required

assign_policy_type_definition

POST

/api/v2/brands/assign_policy_type_definition

Code
Assign a policy type definition to a brand

assign_policy_type_definition › Request Body

Request payload for /api/v2/brands/assign_policy_type_definition

request-assign_policy_type_definition

brand_id

string · required

Brand identifier

location_id

string · required

Business location identifier

policy_type_definition_id

string · required

Policy type definition identifier

assign_policy_type_definition › Responses

200

Response payload for /api/v2/brands/assign_policy_type_definition

response-assign_policy_type_definition

required

brand_association-def · required

Brand association definition schema

success

boolean · required

POST/api/v2/brands/assign_policy_type_definition

curl --request POST \
  --url /api/v2/brands/assign_policy_type_definition \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand_id": "brand_id",
  "location_id": "location_id",
  "policy_type_definition_id": "policy_type_definition_id"
}
'

Example Request Body

{
  "brand_id": "brand_id",
  "location_id": "location_id",
  "policy_type_definition_id": "policy_type_definition_id"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "brand_id": "brand_id",
    "location_id": "location_id",
    "policy_type_definition_id": "policy_type_definition_id",
    "date_created": "2024-08-25T15:00:00Z",
    "date_updated": "2024-08-25T15:00:00Z"
  },
  "success": true
}

json

application/json

attach_file

POST

/api/v2/brands/attach_file

Code
Attach a logo or signature file to a brand

attach_file › Request Body

Request payload for /api/v2/uploads/attach_file.

request-attach_file

entity_id

string · uuid · required

Entity ID to attach the file to. The id must be for an entity of the type specified in entity_type.

entity_type

string · enum · required

Defines the entity type to attach the file to. If revisions is used, the File will be linked to the entity_id.

Enum values:

policies

revisions

subjectivities

folder_name

string · required

Folder name to attach file to. The folder will be created under the policy if it does not exist.

attachment

string · required

Base64 encoded file content

title

string · required

File name.

mime_type

string · required

File MIME type. Example: application/pdf

set_file_private

boolean

If true, set the file to private. Defaults to False.

set_folder_private_if_new

boolean

If true, set the folder to private if the folder does not already exist. Defaults to False.

date_added

string · date-time

Set when the file was added. Defaults to now. Format: YYYY-mm-ddTHH:MM:SSZ (e.g. 2020-01-01T12:00:00Z). This is UTC time.

attach_file › Responses

200

Response payload for /api/v2/uploads/attach_file.

response-attach_file

required

object · required

success

boolean · required

POST/api/v2/brands/attach_file

curl --request POST \
  --url /api/v2/brands/attach_file \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity_id": "00000000-0000-0000-0000-000000000000",
  "entity_type": "policies",
  "folder_name": "folder_name",
  "attachment": "attachment",
  "title": "title",
  "mime_type": "mime_type",
  "set_file_private": true,
  "set_folder_private_if_new": true,
  "date_added": "2024-08-25T15:00:00Z"
}
'

Example Request Body

{
  "entity_id": "00000000-0000-0000-0000-000000000000",
  "entity_type": "policies",
  "folder_name": "folder_name",
  "attachment": "attachment",
  "title": "title",
  "mime_type": "mime_type",
  "set_file_private": true,
  "set_folder_private_if_new": true,
  "date_added": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "attachment_id": "00000000-0000-0000-0000-000000000000",
    "entity_id": "00000000-0000-0000-0000-000000000000"
  },
  "success": true
}

json

application/json

delete_brand

POST

/api/v2/brands/delete_brand

Code
Delete a brand

delete_brand › Request Body

Request payload for /api/v2/brands/delete_brand

request-delete_brand

id

string · required

The unique identifier of the brand to delete

delete_brand › Responses

200

Response payload for /api/v2/brands/delete_brand

response-delete_brand

required

success

boolean · required

get_brand

POST

/api/v2/brands/get_brand

Code
Get a specific brand by ID

get_brand › Request Body

Request payload for /api/v2/brands/get_brand

request-get_brand

id

string · required

The unique identifier of the brand

get_brand › Responses

200

Response payload for /api/v2/brands/get_brand

response-get_brand

required

brand-def · required

Brand definition schema

success

boolean · required

list_brand_associations

POST

/api/v2/brands/list_brand_associations

Code
List all brand associations

list_brand_associations › Request Body

Request Schema for /api/v2/brands/list_brand_associations

request-list_brand_associations

list_brand_associations › Responses

200

Response Schema for /api/v2/brands/list_brand_associations

response-list_brand_associations

required

brand_association-def[] · required

success

boolean · required

list_brands

POST

/api/v2/brands/list_brands

Code
List all brands

list_brands › Request Body

Request Schema for /api/v2/brands/list_brands

request-list_brands

list_brands › Responses

200

Response Schema for /api/v2/brands/list_brands

response-list_brands

required

brand-def[] · required

success

boolean · required

unassign_business_location

POST

/api/v2/brands/unassign_business_location

Code
Unassign a business location from a brand

unassign_business_location › Request Body

Request payload for /api/v2/brands/unassign_business_location

request-unassign_business_location

location_id

string · required

Business location identifier

unassign_business_location › Responses

200

Response payload for /api/v2/brands/unassign_business_location

response-unassign_business_location

required

success

boolean · required

unassign_policy_type_definition

POST

/api/v2/brands/unassign_policy_type_definition

Code
Unassign a policy type definition from a brand

unassign_policy_type_definition › Request Body

Request payload for /api/v2/brands/unassign_policy_type_definition

request-unassign_policy_type_definition

location_id

string · required

Business location identifier

policy_type_definition_id

string · required

Policy type definition identifier

unassign_policy_type_definition › Responses

200

Response payload for /api/v2/brands/unassign_policy_type_definition

response-unassign_policy_type_definition

required

success

boolean · required

update_brand

POST

/api/v2/brands/update_brand

Code
Update an existing brand

update_brand › Request Body

Request payload for /api/v2/brands/update_brand

request-update_brand

id

string · required

The unique identifier of the brand

name

string · maxLength: 100

Brand name

logo_file_id

string

File ID for the brand logo

signature_file_id

string

File ID for the brand signature

header_line_1

string

Header line 1

header_line_2

string

Header line 2

header_line_3

string

Header line 3

header_line_4

string

Header line 4

active

boolean

Whether the brand is active

update_brand › Responses

200

Response payload for /api/v2/brands/update_brand

response-update_brand

required

brand-def · required

Brand definition schema

success

boolean · required

POST/api/v2/brands/update_brand

curl --request POST \
  --url /api/v2/brands/update_brand \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "id",
  "name": "name",
  "logo_file_id": "logo_file_id",
  "signature_file_id": "signature_file_id",
  "header_line_1": "header_line_1",
  "header_line_2": "header_line_2",
  "header_line_3": "header_line_3",
  "header_line_4": "header_line_4",
  "active": true
}
'

Example Request Body

{
  "id": "id",
  "name": "name",
  "logo_file_id": "logo_file_id",
  "signature_file_id": "signature_file_id",
  "header_line_1": "header_line_1",
  "header_line_2": "header_line_2",
  "header_line_3": "header_line_3",
  "header_line_4": "header_line_4",
  "active": true
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "logo_file_id": "logo_file_id",
    "signature_file_id": "signature_file_id",
    "header_line_1": "header_line_1",
    "header_line_2": "header_line_2",
    "header_line_3": "header_line_3",
    "header_line_4": "header_line_4",
    "active": true,
    "date_created": "2024-08-25T15:00:00Z",
    "date_updated": "2024-08-25T15:00:00Z"
  },
  "success": true
}

json

application/json

billing business_locations