> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# SetDeliveryCarrierActiveStatus

# Package: shippingDelivery

# Namespace: DeliveryProfiles

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/set-delivery-carrier-active-status.md

## Permission Scopes:
Manage eCommerce - all permissions: SCOPE.DC-ECOM-MEGA.MANAGE-ECOM

## Introduction

Sets a delivery carrier's active status.

---

## REST API

### Schema

```
 Method: setDeliveryCarrierActiveStatus
 Description: Sets a delivery carrier's active status.
 URL: https://www.wixapis.com/ecom/v1/delivery-profiles/delivery-carriers/set-active-status
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  carrierAppId, rowId, active
 Method parameters: 
   param name: active | type: active | description: Whether the configuration defined in the row is active. | required: true
   param name: carrierAppId | type: carrierAppId | description: Carrier app GUID. | required: true
   param name: rowId | type: rowId | description: Row identifier in the carrier's dashboard settings table that identifies the specific shipping configuration to update.  Pass the `row.key` field from the response of [List Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-delivery-carriers.md). | required: true
 Return type: SetDeliveryCarrierActiveStatusResponse
  EMPTY-OBJECT {}

 Possible Errors:
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: DELIVERY_CARRIER_NOT_FOUND | Description: none


```

### Examples

### Set delivery carrier active status
Sets the active status of a delivery carrier within a delivery profile

```curl
curl -X POST \
  'https://www.wixapis.com/ecom/v1/delivery-profiles/delivery-carriers/set-active-status' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrierAppId": "50d8c12f-715e-41ad-be25-d0f61375dbee",
    "rowId": "71f34b5a-470a-48ba-9e9f-15d35ff1125b",
    "active": false
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.shippingDelivery.DeliveryProfiles.setDeliveryCarrierActiveStatus(carrierAppId, options)
 Description: Sets a delivery carrier's active status.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  carrierAppId, options.rowId, options.active, options
 Method parameters: 
   param name: carrierAppId | type: string | description: Carrier app GUID. | required: true
   param name: options | type: SetDeliveryCarrierActiveStatusOptions  none | required: true
        - name: rowId | type: string | description: Row identifier in the carrier's dashboard settings table that identifies the specific shipping configuration to update.  Pass the `row.key` field from the response of [List Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-delivery-carriers.md). | required: true
        - name: active | type: boolean | description: Whether the configuration defined in the row is active. | required: true
 Return type: PROMISE<SetDeliveryCarrierActiveStatusResponse>
  EMPTY-OBJECT {}

 Possible Errors:
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: DELIVERY_CARRIER_NOT_FOUND | Description: none


```

### Examples

### setDeliveryCarrierActiveStatus
```javascript
import { deliveryProfile } from '@wix/ecom';

async function setDeliveryCarrierActiveStatus(carrierAppId,options) {
  const response = await deliveryProfile.setDeliveryCarrierActiveStatus(carrierAppId,options);
};
```

### setDeliveryCarrierActiveStatus (with elevated permissions)
```javascript
import { deliveryProfile } from '@wix/ecom';
import { auth } from '@wix/essentials';

async function mySetDeliveryCarrierActiveStatusMethod(carrierAppId,options) {
  const elevatedSetDeliveryCarrierActiveStatus = auth.elevate(deliveryProfile.setDeliveryCarrierActiveStatus);
  const response = await elevatedSetDeliveryCarrierActiveStatus(carrierAppId,options);
}
```

### setDeliveryCarrierActiveStatus (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { deliveryProfile } from '@wix/ecom';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { deliveryProfile },
  // Include the auth strategy and host as relevant
});


async function setDeliveryCarrierActiveStatus(carrierAppId,options) {
  const response = await myWixClient.deliveryProfile.setDeliveryCarrierActiveStatus(carrierAppId,options);
};
```

---