SPsponsorunited
Brand

Create a new brand

Creates a new brand with the provided data. The logo URL is downloaded and stored first: when it cannot be downloaded or is not a usable image, the brand is not saved and the request fails with 422. The brand is approved when the user has the create-companies-auto-approve permission, unless the request sends approved=false. Sending approved=true never approves a brand for a user without that permission.

post/api/company

Request

Headers

X-Agent-Namestring
Example:News Agent

Name of the agent making the change, for example News Agent. Recorded as created_by_agent / updated_by_agent only when the request carries an agent token; ignored otherwise. At most 100 characters.

Request body

namestring required

Brand name

logostring required

Logo image URL. A URL already on the upload bucket is kept as it is; any other URL is downloaded and stored, and the brand is not created when that fails.

category_idinteger required

Category ID

subcategory_idinteger required

Subcategory ID

corporate_phonestring nullable
websitestring required

Brand website URL

linkedinstring nullable

LinkedIn URL

locationsobject[] required
youtubestring nullable
twitterstring nullable
facebookstring nullable
instagramstring nullable
twitchstring nullable
tiktokstring nullable
synopsisstring nullable
marketsobject[] nullable
organizationsinteger[] nullable
brandsobject[] nullable
parent_company_idinteger nullable
approvedboolean nullable

Send false to save the brand unapproved even when the user may auto-approve brands. It can only lower the approval: true, null or leaving it out keeps the default, which follows the create-companies-auto-approve permission

Response

Brand created successfully

created_by_agentstring nullable

Name of the agent that created the brand, from the X-Agent-Name header sent with an agent token. Null when a person created it.

Changes

No recorded changes to this operation across all 2 revisions of this API.