serviceProfiles

Create service profile

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

ServiceProfile + Create

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge></div> </Info>

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)
<Info> Enabling services (SMS, Data etc.) is done via `PUT` to `/api/v1/service_profile/{profile_id}/service/{service_id}`. </Info>
post/api/v1/service_profile

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/service_profile
  • Auth: HTTP bearer

Request body

namestring
descriptionstring
allowed_3gboolean
allowed_4gboolean
allowed_nb_iotboolean
allowed_nb_iot_geoboolean

Allows or restricts NB-IoT connectivity over satellite networks.

apply_sms_quotaboolean
apply_data_quotaboolean
retailboolean
sms_p2p_intboolean
sms_p2p_extboolean
prepaidboolean
nipdpboolean
api_callbackApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaApiCallback
api_secretApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaApiSecret
moc_callbackApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaMocCallback
esme_interface_typeApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaEsmeInterfaceType
breakout_regionApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaBreakoutRegion
dnsApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaDns

Response

Resource Created

ServiceProfilesServiceProfilePostResponse201 required

Empty response body

Changes

No recorded changes to this operation across all 1 revision of this API.