Create brands
Bulk-creates brands. Successful entities are returned in data; per-item failures in errors keyed by slug.
POST
/api/v2/{team_slug}/{app_slug}/brandsAuthorization
AuthorizationBearer token · headerrequiredManagement API token, sent as Authorization: Bearer <token>.
Path parameters
team_slugstringrequiredapp_slugstringrequiredRequest body
requiredapplication/jsonbrandsCreateBrandItem[]requiredmin items 1 · max items 20
Show propertiesHide properties
Array of
CreateBrandItemnamestringrequiredslugstringrequireddescriptionstring | nullemailstring | nullcover_idUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nulllogo_idUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nulladdressBrandAddress | nullShow propertiesHide properties
Any of:
BrandAddress
street_addressstringrequiredco_addressstring | nullcitystringrequiredstate_provincestring | nullhouse_numberstring | nullpostal_codestringrequiredcountrystringrequirednull
nullResponses
201
Created (partial success possible)
dataBrand[]requiredShow propertiesHide properties
Array of
BrandidUUIDrequirednamestringrequiredslugstringrequiredcoverBrandImage | nullShow propertiesHide properties
Any of:
BrandImage
idUUIDrequiredtitlestring | nullurlstringrequirednull
nulllogoBrandImage | nullShow propertiesHide properties
Any of:
BrandImage
idUUIDrequiredtitlestring | nullurlstringrequirednull
nulldescriptionstring | nullemailstring | nulladdressBrandAddressShow propertiesHide properties
street_addressstringrequiredco_addressstring | nullcitystringrequiredstate_provincestring | nullhouse_numberstring | nullpostal_codestringrequiredcountrystringrequiredcreated_atstring<date-time>requiredupdated_atstring<date-time> | nullseriesBrandSeries[] | nullShow propertiesHide properties
Array of
BrandSeriesidUUIDrequirednamestringrequiredslugstringrequiredcoverBrandImage | nullShow propertiesHide properties
Any of:
BrandImage
BrandImagenull
nulllogoBrandImage | nullShow propertiesHide properties
Any of:
BrandImage
BrandImagenull
nulldescriptionstring | nullemailstring | nullcreated_atstring<date-time>updated_atstring<date-time> | nulltranslationsBrandTranslationtranslationsBrandTranslationShow propertiesHide properties
descriptionTranslation[]Show propertiesHide properties
Array of
TranslationidUUIDlocalestringvaluestringerrorsBrandError[]requiredShow propertiesHide properties
Array of
BrandErrorslugstringidUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullmessagestringrequired400
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required401
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required403
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required500
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required