Skip to main content
POST
Modify Data Extension

Authorizations

Authorization
string
header
required

Use your app's API_KEY as the username, and leave the password blank

Path Parameters

connection_id
string<uuid>
required

ID of the connection to use for the data extension modification

Query Parameters

request_id
string

A custom ID that can be used to identify the request and response. This could be your local ID for the request.

Example:

"1"

webhook_url
string<uri>

Optional URL to receive a webhook when the request is completed

Body

application/json
owner_id
string
required

Owner ID of the data extension. Use "0" for a data extension owned by this application, or a GUID for one owned by a specific third-party application.

data_ext_name
string
required

Name of the previously defined data extension field

Maximum string length: 31
data_ext_value
string
required

New value to set for the data extension

list_data_ext_type
enum<string>

Type of list object the data extension belongs to. Use with list_id or full_name. Mutually exclusive with txn_data_ext_type and other_data_ext_type.

Available options:
Account,
Customer,
Employee,
Item,
OtherName,
Vendor
list_id
string

ListID of the list object to modify (used with list_data_ext_type). Provide this or full_name.

full_name
string

FullName of the list object to modify (used with list_data_ext_type). Provide this or list_id.

txn_data_ext_type
enum<string>

Type of transaction the data extension belongs to. Use with txn_id. Mutually exclusive with list_data_ext_type and other_data_ext_type.

Available options:
ARRefundCreditCard,
Bill,
BillPaymentCheck,
BillPaymentCreditCard,
BuildAssembly,
Charge,
Check,
CreditCardCharge,
CreditCardCredit,
CreditMemo,
Deposit,
Estimate,
InventoryAdjustment,
Invoice,
ItemReceipt,
JournalEntry,
PurchaseOrder,
ReceivePayment,
SalesOrder,
SalesReceipt,
SalesTaxPaymentCheck,
VendorCredit
txn_id
string

TxnID of the transaction to modify (required with txn_data_ext_type)

txn_line_id
string

Optional TxnLineID for a line-level transaction data extension

other_data_ext_type
enum<string>

Set to "Company" to target the company data extension. Mutually exclusive with list_data_ext_type and txn_data_ext_type.

Available options:
Company

Response

Data extension modification request accepted and queued for processing. Returns a queued request object.

data
object