Update Service Level

Beta

PATCH/v1/operations/carriers/{carrier_id}/service-levels/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates a service level.

System-owned service levels cannot be updated.

carrier_idstring

Carrier ID.

idstring

Service level ID.

include[]optional arrayenumValues:ownerowner.account

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

nameoptional string

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

codeoptional string

Carrier-specific code identifying this service level (e.g. fedex_ground).

Must be unique among the carrier's service levels.

customer_portal_visibilityoptional stringenumValues:visiblehidden

Whether this service level will be available for customers to select in the customer portal.

is_defaultoptional boolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting this to true clears the carrier's existing default.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerobjectExpandablenullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Owner type, identifying where the resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountobjectExpandablenullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

brandingobjectnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.

portalobjectnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Service Level

Update Service Level

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const serviceLevel = await client.operations.carriers.serviceLevels.update(
  'crop_01cfaf03f104e90ef9680e2a30',
  { carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6', name: 'Express Shipping' },
);

console.log(serviceLevel.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const serviceLevel = await client.operations.carriers.serviceLevels.update(
  'crop_01cfaf03f104e90ef9680e2a30',
  { carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6', name: 'Express Shipping' },
);

console.log(serviceLevel.id);

200 example

{
  "id": "crop_01cfaf03f104e90ef9680e2a30",
  "object": "service_level",
  "name": "FedEx Ground",
  "service_level_token": "fedex_ground",
  "customer_portal_visibility": "visible",
  "is_default": false,
  "owner": {
    "object": "owner",
    "type": "account",
    "account": {
      "id": "ac_01148680966698341a9c0976db",
      "object": "account",
      "name": "Acme Inc.",
      "default_billing_address": null,
      "default_shipping_address": null,
      "branding": null,
      "portal": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "crop_01cfaf03f104e90ef9680e2a30",
  "object": "service_level",
  "name": "FedEx Ground",
  "service_level_token": "fedex_ground",
  "customer_portal_visibility": "visible",
  "is_default": false,
  "owner": {
    "object": "owner",
    "type": "account",
    "account": {
      "id": "ac_01148680966698341a9c0976db",
      "object": "account",
      "name": "Acme Inc.",
      "default_billing_address": null,
      "default_shipping_address": null,
      "branding": null,
      "portal": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Service Level

Path Parameters

Query Parameters

Request Body

Returns

Responses