Skip to main content
PUT
Create a line under a caller-chosen id

Authorizations

X-API-Key
string
header
required

Headers

x-broker-id
string
required
Minimum string length: 1

Path Parameters

id
string<uuid>
required

Body

application/json
msisdn
string
required
Pattern: ^[1-9]\d{10,14}$
simCardType
enum<string>
required
Available options:
ESIM,
PHYSICAL
holderId
string
required
Minimum string length: 1
products
object[]
required
Minimum array length: 1
iccId
string | null
Pattern: ^\d{19,20}$
imsi
string | null
Pattern: ^\d{14,15}$
paymentTransactionId
string<uuid>
paymentMethodId
string<uuid>
externalCode
string | null
metadata
object
portedMsisdn
string
Pattern: ^[1-9]\d{10,14}$

Response

Default Response

id
string
required
status
enum<string>
required
Available options:
PROVISIONING,
PROVISIONING_ERROR,
STAND_BY,
ACTIVATING,
ACTIVATION_ERROR,
ACTIVE,
BLOCKING,
BLOCKING_ERROR,
BLOCKED,
UNBLOCKING,
UNBLOCKING_ERROR,
TERMINATING,
TERMINATION_ERROR,
TERMINATED
msisdn
string
required
simCardType
enum<string>
required
Available options:
ESIM,
PHYSICAL
simCard
object | null
required
holder
object
required
subscriptionId
null | string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
activatedAt
string<date-time> | null
required
terminatedAt
string<date-time> | null
required
externalCode
null | string
required
brokerId
null | string
required
metadata
object
required