latestOpenAPI 3.0.3MIT2026-08-10102048.8 KB

b49d3ae283fd

brands

Create and submit a brand

The endpoint creates and submits a new brand for the specified project in new status. The brand is validated against the brand type format.

post/v1/projects/{projectId}/brands:submit

Path parameters

projectIdstring required

Customer's project id

Request body

brandIdstring

The unique identifier for the brand.

brandNamestring

The name of the brand.

brandMetadataIdstring

The unique identifier for the brand metadata.

dataBrandCategory[]

The list of categories included in the brand metadata. Each of them includes a list of attributes.

callbackUrlstring

The URL to receive the brand status update callback. The URL must be a valid URL and must be reachable from Sinch.

createTimestring date-time

The date and time when the brand was created.

updateTimestring date-time

The date and time when the brand was updated.

Example request

{
  "brandId": "1234567890",
  "brandName": "My End Customer Brand Name",
  "brandMetadataId": "4444444444",
  "status": "INCOMPLETE",
  "data": [
    {
      "companyName": "My Company Name",
      "website": "https://www.mycompany.com",
      "employeeCount": 150,
      "isPublic": false
    }
  ],
  "logs": [
    {
      "status": "INCOMPLETE",
      "createTime": "2023-10-01 12:00:00+00:00",
      "comment": "Brand created successfully.",
      "author": "CUSTOMER"
    }
  ],
  "callbackUrl": "https://example.com/callback",
  "createTime": "2023-10-01 12:00:00+00:00",
  "updateTime": "2023-10-01 12:00:00+00:00"
}

Response

Brand created and submitted successfully