SIsinch
brands

Uploads an attachment to be linked to a brand. The attachment will be automatically assigned to the new Brand Orders when needed.

Upload an attachment to be linked to a brand.

post/v1/projects/{projectId}/us/brands/{brandId}/attachments

Request

  • Base URL
    https://compliance.api.sinch.com
  • URL
    https://compliance.api.sinch.com/v1/projects/{projectId}/us/brands/{brandId}/attachments
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.sinch.com/oauth2/token scopes: write

Path parameters

projectIdstring required
Example:eeew32344324edewe2e3

Customer's project id

brandIdstring required

Customer's brand id

Request body multipart/form-data

filestring binary required

File content body

attachmentType'COMPANY_BANNER' | 'COMPANY_LOGO' required

Attachment type

Example request

{
  "file": "file.txt",
  "attachmentType": "COMPANY_BANNER"
}

Response

Attachment uploaded successfully.

attachmentIdstring

Unique identifier of the attachment.

fileNamestring

Human readable name of the attachment.

attachmentType'COMPANY_BANNER' | 'COMPANY_LOGO'

Attachment type

mimeTypestring

MIME type of the attachment file.

uploadStatus'COMPLETED' | 'WAITING' | 'FAILED'

Status of the file uploaded

createTimestring date-time

Create time of the request. ISO date time format in UTC.

updateTimestring date-time

Update time of the request. ISO date time format in UTC.

Example response

{
  "attachmentId": "d1c7ccbf-919d-462f-8587-dec95a1b11ee",
  "fileName": "sender_id_registration_form.docx",
  "attachmentType": "COMPANY_BANNER",
  "mimeType": "application/pdf",
  "uploadStatus": "COMPLETED",
  "createTime": "2021-11-03T14:30:03Z",
  "updateTime": "2021-11-03T14:30:03Z"
}

Changes

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