Brands

Base URL: https://app.neuroflash.com/api/brand-voice-service

Manage brand entities associated with brand voices.

Create a new brand

POST/v1/workspaces/{workspaceId}/brands

Create a new brand for the given workspace

Path Parameters

Parameter	Type	Required	Description
`workspaceId`	string	Yes	Workspace ID (uuid4)

Request Body

addressstringYes

emailstringYes

facebookLinkstringYes

instagramLinkstringYes

linkedinLinkstringYes

namestringYes

phonesarray<string>Yes

valuesarray<string>Yes

websitestringYes

Response

addressstring

createdAtstring

createdByUserIdstring

emailstring

facebookLinkstring

idstring

instagramLinkstring

legacybooleanwhile this flag is true, the brand cannot yet be edited and it needs to be converted into a non-legacy brand voice first

linkedinLinkstring

namestring

ownerLegacyCustomerIdinteger

phonesarray<string>

updatedAtstring

valuesarray<string>

websitestring

Example

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brands" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "address": "string",
      "email": "string",
      "facebookLink": "string",
      "instagramLink": "string",
      "linkedinLink": "string",
      "name": "string",
      "phones": [],
      "values": [],
      "website": "string"
  }'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brands",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "address": "string",
        "email": "string",
        "facebookLink": "string",
        "instagramLink": "string",
        "linkedinLink": "string",
        "name": "string",
        "phones": [],
        "values": [],
        "website": "string"
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brands`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "address": "string",
          "email": "string",
          "facebookLink": "string",
          "instagramLink": "string",
          "linkedinLink": "string",
          "name": "string",
          "phones": [],
          "values": [],
          "website": "string"
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"address": "string",
		"email": "string",
		"facebookLink": "string",
		"instagramLink": "string",
		"linkedinLink": "string",
		"name": "string",
		"phones": []any{},
		"values": []any{},
		"website": "string",
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brands", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Response:

{
  "address": "Germany, Berlin, ...",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "email": "test@neuroflash.com",
  "facebookLink": "https://facebook.com/test",
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "instagramLink": "https://instagram.com/test",
  "legacy": false,
  "linkedinLink": "https://linkedin.com/test",
  "name": "neuroflash",
  "ownerLegacyCustomerId": 32,
  "phones": [
    "+00000000",
    "+11111111"
  ],
  "updatedAt": "2025-01-14T16:20:59Z",
  "values": [
    "proactivity",
    "stability"
  ],
  "website": "https://test.com"
}

List brands

GET/v1/workspaces/{workspaceId}/brands

Retrieve a paginated list of brands for the given workspace

Path Parameters

Parameter	Type	Required	Description
`workspaceId`	string	Yes	Workspace ID (uuid4)

Query Parameters

Parameter	Type	Default	Description
`page`	integer	`1`	Page number
`size`	integer	`10`	Page size

Response

dataarray<object>

addressstring

createdAtstring

createdByUserIdstring

emailstring

facebookLinkstring

idstring

instagramLinkstring

legacybooleanwhile this flag is true, the brand cannot yet be edited and it needs to be converted into a non-legacy brand voice first

linkedinLinkstring

namestring

ownerLegacyCustomerIdinteger

phonesarray<string>

updatedAtstring

valuesarray<string>

websitestring

pageobject

currentPageinteger

sizeinteger

totalElementsinteger

totalPagesinteger

Example

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brands" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brands",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brands`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brands", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Response:

{
  "data": [
    {
      "address": "Germany, Berlin, ...",
      "createdAt": "2025-01-14T16:20:59Z",
      "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
      "email": "test@neuroflash.com",
      "facebookLink": "https://facebook.com/test",
      "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
      "instagramLink": "https://instagram.com/test",
      "legacy": false,
      "linkedinLink": "https://linkedin.com/test",
      "name": "neuroflash",
      "ownerLegacyCustomerId": 32,
      "phones": [
        "+00000000",
        "+11111111"
      ],
      "updatedAt": "2025-01-14T16:20:59Z",
      "values": [
        "proactivity",
        "stability"
      ],
      "website": "https://test.com"
    }
  ],
  "page": {
    "currentPage": 2,
    "size": 10,
    "totalElements": 35,
    "totalPages": 4
  }
}

Get brand by ID

GET/v1/workspaces/{workspaceId}/brands/{brandId}

Retrieve details of a brand by its ID for the given workspace

Path Parameters

Parameter	Type	Required	Description
`workspaceId`	string	Yes	Workspace ID (uuid4)
`brandId`	string	Yes	Brand ID

Response

addressstring

createdAtstring

createdByUserIdstring

emailstring

facebookLinkstring

idstring

instagramLinkstring

legacybooleanwhile this flag is true, the brand cannot yet be edited and it needs to be converted into a non-legacy brand voice first

linkedinLinkstring

namestring

ownerLegacyCustomerIdinteger

phonesarray<string>

updatedAtstring

valuesarray<string>

websitestring

Example

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brands/{brand_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brands/{brand_id}",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brands/${brandId}`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brands/"+brandID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Response:

{
  "address": "Germany, Berlin, ...",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "email": "test@neuroflash.com",
  "facebookLink": "https://facebook.com/test",
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "instagramLink": "https://instagram.com/test",
  "legacy": false,
  "linkedinLink": "https://linkedin.com/test",
  "name": "neuroflash",
  "ownerLegacyCustomerId": 32,
  "phones": [
    "+00000000",
    "+11111111"
  ],
  "updatedAt": "2025-01-14T16:20:59Z",
  "values": [
    "proactivity",
    "stability"
  ],
  "website": "https://test.com"
}

Update a brand

PUT/v1/workspaces/{workspaceId}/brands/{brandId}

Update a brand by its ID for the given workspace

Path Parameters

Parameter	Type	Required	Description
`workspaceId`	string	Yes	Workspace ID (uuid4)
`brandId`	string	Yes	Brand ID

Request Body

addressstringYes

emailstringYes

facebookLinkstringYes

instagramLinkstringYes

linkedinLinkstringYes

namestringYes

phonesarray<string>Yes

valuesarray<string>Yes

websitestringYes

Response

addressstring

createdAtstring

createdByUserIdstring

emailstring

facebookLinkstring

idstring

instagramLinkstring

legacybooleanwhile this flag is true, the brand cannot yet be edited and it needs to be converted into a non-legacy brand voice first

linkedinLinkstring

namestring

ownerLegacyCustomerIdinteger

phonesarray<string>

updatedAtstring

valuesarray<string>

websitestring

Example

cURL
Python
Node.js
Go

curl -X PUT "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brands/{brand_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "address": "string",
      "email": "string",
      "facebookLink": "string",
      "instagramLink": "string",
      "linkedinLink": "string",
      "name": "string",
      "phones": [],
      "values": [],
      "website": "string"
  }'

import requests

response = requests.put(
    f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brands/{brand_id}",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "address": "string",
        "email": "string",
        "facebookLink": "string",
        "instagramLink": "string",
        "linkedinLink": "string",
        "name": "string",
        "phones": [],
        "values": [],
        "website": "string"
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brands/${brandId}`,
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "address": "string",
          "email": "string",
          "facebookLink": "string",
          "instagramLink": "string",
          "linkedinLink": "string",
          "name": "string",
          "phones": [],
          "values": [],
          "website": "string"
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"address": "string",
		"email": "string",
		"facebookLink": "string",
		"instagramLink": "string",
		"linkedinLink": "string",
		"name": "string",
		"phones": []any{},
		"values": []any{},
		"website": "string",
	})

req, _ := http.NewRequest("PUT", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brands/"+brandID+"", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Response:

{
  "address": "Germany, Berlin, ...",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "email": "test@neuroflash.com",
  "facebookLink": "https://facebook.com/test",
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "instagramLink": "https://instagram.com/test",
  "legacy": false,
  "linkedinLink": "https://linkedin.com/test",
  "name": "neuroflash",
  "ownerLegacyCustomerId": 32,
  "phones": [
    "+00000000",
    "+11111111"
  ],
  "updatedAt": "2025-01-14T16:20:59Z",
  "values": [
    "proactivity",
    "stability"
  ],
  "website": "https://test.com"
}

Delete a brand

DELETE/v1/workspaces/{workspaceId}/brands/{brandId}

Delete a brand by its ID for the given workspace

Path Parameters

Parameter	Type	Required	Description
`workspaceId`	string	Yes	Workspace ID (uuid4)
`brandId`	string	Yes	Brand ID

Example

cURL
Python
Node.js
Go

curl -X DELETE "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brands/{brand_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

requests.delete(
    f"https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/{workspace_id}/brands/{brand_id}",
    headers={"Authorization": f"Bearer {token}"},
)

await fetch(
  `https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/${workspaceId}/brands/${brandId}`,
  {
    method: "DELETE",
    headers: { Authorization: `Bearer ${token}` },
  }
);

req, _ := http.NewRequest("DELETE", "https://app.neuroflash.com/api/brand-voice-service/v1/workspaces/"+workspaceID+"/brands/"+brandID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Create a new brand​

Path Parameters​

Request Body​

Response​

Example​

List brands​

Path Parameters​

Query Parameters​

Response​

Example​

Get brand by ID​

Path Parameters​

Response​

Example​

Update a brand​

Path Parameters​

Request Body​

Response​

Example​

Delete a brand​

Path Parameters​

Example​

Create a new brand

Path Parameters

Request Body

Response

Example

List brands

Path Parameters

Query Parameters

Response

Example

Get brand by ID

Path Parameters

Response

Example

Update a brand

Path Parameters

Request Body

Response

Example

Delete a brand

Path Parameters

Example