Update a Brand

put

https://rcs-api.in.kaleyra.io/v1/{sid}/rcs/brand/{brand_number}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Update a BrandAPI allows you to modify specific brand fields. Updates that depend on brand status are not handled by go-cloud.

📘
Note:
Before submitting any update, you must first retrieve the current brand details. The go-cloud API compares the existing brand data with the update request to determine which field changes are allowed.

Prerequisites

After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in kaleyra.io.
Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
To send any RCS messages, you must configure the RCS channel in the Kaleyra platform. To configure the RCS channel in your account, please contact your local Kaleyra representative.

Path Params

sid

string

required

Account SID / Security Identifier.

IMPORTANT:
This parameter is part of the URL path and therefore the URL
contains /{sid}/...

brand_number

string

required

System-generated Brand Number.

The Brand Number is immutable and identifies the RCS Brand.

Body Params

Request body for updating an RCS Brand.

Mutable fields:

brand_name
display_name
brand_description
partner_name
partner_email
contact_name
contact_email
website_url
image_id
thumbnail_imageid

Restricted fields:

brand_number
provider_brand_no
org_id
status
created_date
modified_date
id

brand_name

string

required

length ≤ 100

Brand name. Mutable.

brand_number

string

required

Auto-generated Brand Number. Restricted.

display_name

string

required

length ≤ 100

Display name. Mutable.

brand_description

string

required

length ≤ 200

Brand description. Mutable.

provider_brand_no

string

required

Provider-generated Brand Number. Restricted.

org_id

string

required

Organization UUID. Restricted.

partner_name

string

required

length ≤ 200

Partner name. Mutable.

partner_email

string

required

Partner email. Mutable.

contact_name

string

required

length ≤ 200

Contact name. Mutable.

contact_email

string

required

Contact email. Mutable.

website_url

uri

required

Website URL. Mutable.

image_id

uri

required

Brand image URL. Mutable.

thumbnail_imageid

uri

required

Thumbnail image URL. Mutable.

status

string

enum

required

Brand status. Restricted.

Allowed:

created_date

string

required

Brand creation date. Restricted.

modified_date

string

required

Brand modification date. Restricted.

string

required

Unique Brand ID. Restricted.

Headers

api-key

string

required

API key generated from the Kaleyra.io account.

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Note:

Prerequisites

200Brand updated successfully.

400Bad Request.

500Internal Server Error.

4XXDownstream provider error.