| Requires any of the roles: | admin, oauthadmin | Required permissions: | /admin/email/, Informz |
| POST | /Ams/{ClientID}/InformzBulkUploadForOrders | Upload emails and personal data to Informz for orders. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GroupName | body | string | No | |
| DateMin | body | string | No | |
| DateMax | body | string | No | |
| EventId | body | int? | No | |
| CardFailed | body | bool | No | |
| InvoiceNo | body | int? | No | |
| PaymentOption | body | int? | No | |
| cdlIDsToExclude | body | string | No | |
| DateSentMin | body | string | No | |
| DateSentMax | body | string | No | |
| CreatePrintSet | body | bool | No | |
| AdminUserID | body | int? | No | |
| HasOutstandingBalance | body | int? | No | |
| DateBalanceMin | body | string | No | |
| DateBalanceMax | body | string | No | |
| Organization | body | string | No | |
| EventRelatedOrdersOnly | body | bool | No | |
| cdlOrderStatus | body | string | No | |
| cdlProductID | body | string | No | |
| datPaymentAppliedMin | body | string | No | |
| datPaymentAppliedMax | body | string | No | |
| datPaymentCreatedMin | body | string | No | |
| datPaymentCreatedMax | body | string | No | |
| Name | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Ams/{ClientID}/InformzBulkUploadForOrders HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"GroupName":"String","DateMin":"String","DateMax":"String","EventId":0,"CardFailed":false,"InvoiceNo":0,"PaymentOption":0,"cdlIDsToExclude":"String","DateSentMin":"String","DateSentMax":"String","CreatePrintSet":false,"AdminUserID":0,"HasOutstandingBalance":0,"DateBalanceMin":"String","DateBalanceMax":"String","Organization":"String","EventRelatedOrdersOnly":false,"cdlOrderStatus":"String","cdlProductID":"String","datPaymentAppliedMin":"String","datPaymentAppliedMax":"String","datPaymentCreatedMin":"String","datPaymentCreatedMax":"String","Name":"String","UsingRedis":true,"AppInitTime":"2024-05-03T04:46:15.5457256-04:00","ServerID":"WS-4-7-585","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T07:30:48.4021971-04:00","Device":"Desktop"}