Update eSIM brand

PUT

/v2/sims/{sim_iccid}/brand

This endpoint allows you to update assigned brand settings name of a specific eSIM from the Airalo Partners API using the eSIM's ICCID. This brand is used to apply branding on sharing link or share e-mails.If brand is set as null value, eSIM will be shared with unbranded visual.

The access token, obtained from the "Request Access Token" endpoint, should be included in the request.

For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ

Request

Path Params

sim_iccid

string

required

The ICCID of the eSIM for which you want to update the brand.

Header Params

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {{token}}

Body Params multipart/form-data

brand_settings_name

string

required

Nullable. The definition under what brand the eSIM should be shared. Null for unbranded.

Example:

our perfect brand

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/v2/sims//brand' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--form 'brand_settings_name="our perfect brand"'

Responses

🟢200Update eSIM Brand (200)

application/json

Body

data

object

required

brand_settings_name

string

required