Zum Hauptinhalt springen

Marken

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

Verwalten Sie Markenenitäten, die mit Markenstimmen verknüpft sind.

Neue Marke erstellen

POST/v1/workspaces/{workspaceId}/brands

Erstelle eine neue Marke für den angegebenen Workspace

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID (uuid4)

Anfrage-Body

FeldTypErforderlichBeschreibung
addressstringJa
emailstringJa
facebookLinkstringJa
instagramLinkstringJa
linkedinLinkstringJa
namestringJa
phonesarray<string>Ja
valuesarray<string>Ja
websitestringJa

Antwort

FeldTypBeschreibung
addressstring
createdAtstring
createdByUserIdstring
emailstring
facebookLinkstring
idstring
instagramLinkstring
legacybooleanWährend dieses Flag wahr ist, kann die Marke noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werden
linkedinLinkstring
namestring
ownerLegacyCustomerIdinteger
phonesarray<string>
updatedAtstring
valuesarray<string>
websitestring

Beispiel

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"
}'

Antwort:

{
"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"
}

Marken auflisten

GET/v1/workspaces/{workspaceId}/brands

Rufen Sie eine paginierte Liste der Marken für den angegebenen Workspace ab

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID (uuid4)

Abfrageparameter

ParameterTypStandardBeschreibung
pageinteger1Seitennummer
sizeinteger10Seitengröße

Antwort

FeldTypBeschreibung
dataarray<object>
addressstring
createdAtstring
createdByUserIdstring
emailstring
facebookLinkstring
idstring
instagramLinkstring
legacybooleanWährend dieses Flag wahr ist, kann die Marke noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werden
linkedinLinkstring
namestring
ownerLegacyCustomerIdinteger
phonesarray<string>
updatedAtstring
valuesarray<string>
websitestring
pageobject
currentPageinteger
sizeinteger
totalElementsinteger
totalPagesinteger

Beispiel

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

Antwort:

{
"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
}
}

Marke nach ID abrufen

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

Rufen Sie Details einer Marke nach ihrer ID für den angegebenen Workspace ab

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID (uuid4)
brandIdstringJaMarken-ID

Antwort

FeldTypBeschreibung
addressstring
createdAtstring
createdByUserIdstring
emailstring
facebookLinkstring
idstring
instagramLinkstring
legacybooleanWährend dieses Flag wahr ist, kann die Marke noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werden
linkedinLinkstring
namestring
ownerLegacyCustomerIdinteger
phonesarray<string>
updatedAtstring
valuesarray<string>
websitestring

Beispiel

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

Antwort:

{
"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"
}

Marke aktualisieren

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

Aktualisiere eine Marke nach ihrer ID für den angegebenen Workspace

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID (uuid4)
brandIdstringJaMarken-ID

Anfrage-Body

FeldTypErforderlichBeschreibung
addressstringJa
emailstringJa
facebookLinkstringJa
instagramLinkstringJa
linkedinLinkstringJa
namestringJa
phonesarray<string>Ja
valuesarray<string>Ja
websitestringJa

Antwort

FeldTypBeschreibung
addressstring
createdAtstring
createdByUserIdstring
emailstring
facebookLinkstring
idstring
instagramLinkstring
legacybooleanWährend dieses Flag wahr ist, kann die Marke noch nicht bearbeitet werden und muss zunächst in eine nicht-Legacy-Markenstimme konvertiert werden
linkedinLinkstring
namestring
ownerLegacyCustomerIdinteger
phonesarray<string>
updatedAtstring
valuesarray<string>
websitestring

Beispiel

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"
}'

Antwort:

{
"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"
}

Marke löschen

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

Lösche eine Marke nach ihrer ID für den angegebenen Workspace

Pfadparameter

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID (uuid4)
brandIdstringJaMarken-ID

Beispiel

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