serviceProfiles

Update 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 + Update

<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>

Update a service profile with a given id.

Editable fields:

  • name (String optional)
  • description (String optional)
  • allowed_3g (boolean optional)
  • allowed_4g (boolean optional). Allows or restricts connectivity for 4G/LTE and LTE-M networks.
  • allowed_nb_iot (boolean optional)
  • 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) can be emptied by setting the id to null ("api_callback":{"id":null})
  • api_secret (object optional) can be emptied by setting the id to null ("api_secret":{"id":null})
  • moc_callback (object optional) can be emptied by setting the id to null ("moc_callback":{"id":null})
  • esme_interface_type (object optional)
  • breakout_region (object optional)
  • dns (object optional)
patch/api/v1/service_profile/{profile_id}

Request

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

Path parameters

profile_idnumber double required

The Numeric ID of a Service Profile

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_callbackApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaApiCallback
api_secretApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaApiSecret
moc_callbackApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaMocCallback
esme_interface_typeApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaEsmeInterfaceType
breakout_regionApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaBreakoutRegion
dnsApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaDns

Response

Successfully updated the Service Profile

ServiceProfilesServiceProfileByProfileIdPatchResponse201 required

Changes

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