Skip to navigation
Service ProfilesCreate service profile

Create service profile

Creates a new Service Profile. A name must be specified for the Service Profile and all other fields are optional.

Editable fields:

  • name (String required)
  • description (String optional)
  • allowed_3g (boolean optional, defaults to true)
  • allowed_4g (boolean optional, defaults to true). Allows or restricts connectivity for 4G/LTE and LTE-M networks.
  • allowed_nb_iot (boolean optional, defaults to true)
  • DEPRECATED apply_quota (boolean optional, defaults to false). Use apply_data_quota instead. Will be ignored if apply_data_quota is present.
  • apply_data_quota (boolean optional, defaults to false)
  • apply_sms_quota (boolean optional, defaults to false)
  • retail (boolean optional, defaults to false)
  • sms_p2p_int (boolean optional, defaults to true)
  • sms_p2p_ext (boolean optional, defaults to true)
  • DEPRECATED prepaid (boolean optional, defaults to false)
  • nipdp (boolean optional, defaults to false)
  • api_callback (object optional)
  • api_secret (object optional)
  • moc_callback (object optional)
  • esme_interface_type (object optional)
  • breakout_region (object optional)
  • dns (object optional)

Enabling services (SMS, Data etc.) is done via PUT to /api/v1/service_profile/{profile_id}/service/{service_id}.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Request

This endpoint expects an object.
namestringOptional
descriptionstringOptional
allowed_3gbooleanOptional
allowed_4gbooleanOptional
allowed_nb_iotbooleanOptional
apply_sms_quotabooleanOptional
apply_data_quotabooleanOptional
retailbooleanOptional
sms_p2p_intbooleanOptional
sms_p2p_extbooleanOptional
prepaidbooleanOptional
nipdpbooleanOptional
api_callbackobjectOptional
api_secretobjectOptional
moc_callbackobjectOptional
esme_interface_typeobjectOptional
breakout_regionobjectOptional
dnsobjectOptional

Response

Resource Created

Errors

403
Forbidden Error