Modify batch of user groups

POST /api-v1/workflow/batch

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

application/json

Body Required

workflowList

blocks array[object]
Hide blocks attributes Show blocks attributes object
- actionType string
  
  Values are ADVANCED_INVOICING, CREATE, DELETE, GENERATE_PAYMENT, GENERATE_PDF_SEND, MODIFY, NONE, SEND_CONFIRMATION, SEND_OFFER, STATUS_BILLABLE, STATUS_CONFIRMED, SUBMIT, or VALIDATE.
- blockType string
  
  Values are TRIGGER or ACTION.
- canModify boolean
- contacts array[object]
  Hide contacts attributes Show contacts attributes object
  
  email string
  
  id integer
  
  name string
- filters string
- generateParams string
- id integer
- isSystemUserGroup boolean
- isSystemUserGroup2 boolean
- position integer
- userGroupIds array[integer]
- userGroupIds2 array[integer]
- users array[object]
  Hide users attributes Show users attributes object
  
  email string
  
  id integer
  
  name string
- users2 array[object]
  Hide users2 attributes Show users2 attributes object
  
  email string
  
  id integer
  
  name string
description string
id integer
isActive boolean
moduleType string

Values are ALL, NONE, CONTACTS, CONTACTS_DETAILS, CONTACTS_SUPPLIER, CONTACTS_CLIENT, CONTACTS_STAFF, CONTACTS_STAFF_DOCUMENTS, CONTACTS_USER, CONTACTS_MAIN_USER, CONTACTS_USER_SECURITY, CONTACTS_USER_PERMISSIONS, CONTACTS_SYSTEM, CONTACTS_DOCUMENTS, CONTACTS_ROLES, CONTACTS_ROLES_SUPPLIER, CONTACTS_ROLES_CLIENT, CONTACTS_ROLES_STAFF, CONTACTS_ROLES_USER, CONTACTS_COMMUNICATIONS, ORGANIZATIONS_USERS_MANAGER, ORGANIZATIONS, ORGANIZATIONS_DETAILS, ORGANIZATIONS_TEMPLATES, ORGANIZATIONS_ACCOUNTING, ORGANIZATIONS_INVOICES, ORGANIZATIONS_SYSTEM, ORGANIZATIONS_SYSTEM_CODES, ORGANIZATIONS_SYSTEM_INVENTORY, ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS, ORGANIZATIONS_SYSTEM_EBICS, ORGANIZATIONS_DOCUMENTS, ORGANIZATIONS_DETAILS_INVOICING, PERMISSION_ROLES, PERMISSION_ROLES_DETAILS, BUSINESS_UNITS, ARTICLE_CATEGORIES, CHART_OF_ACCOUNTS, CHART_OF_ACCOUNTS_DETAILS, ACTIVITY_LOG, CURRENCIES, CURRENCIES_DETAILS, JOURNAL, JOURNAL_DETAILS, JOURNAL_DOCUMENTS, DOCUMENTS, DOCUMENTS_DETAILS, RECONCILIATION, PURCHASE_INVOICES, PURCHASE_INVOICES_DETAILS, PURCHASE_INVOICES_VALIDATION, PURCHASE_INVOICES_ACCOUNTING, PURCHASE_INVOICES_SHIPMENTS, PURCHASE_INVOICES_DOCUMENTS, PURCHASE_INVOICES_ALLOCATION_RULES, PURCHASE_INVOICES_WORKFLOW, SALES_INVOICES, SALES_INVOICES_DETAILS, SALES_INVOICES_VALIDATION, SALES_INVOICES_ACCOUNTING, SALES_INVOICES_DOCUMENTS, SALES_INVOICES_SHIPMENTS, SALES_INVOICES_REPORT, SALES_INVOICES_ALLOCATION_RULES, SALES_INVOICES_WORKFLOW, SALARIES, STOCK_REPORT, STOCK_MOVEMENTS, STOCK_MOVEMENTS_DETAILS, ORDERS, ORDERS_DETAILS, ORDERS_VALIDATION, ORDERS_SHIPMENT, ORDERS_INVOICES, ORDERS_EXPENSES, ORDERS_DOCUMENTS, ORDERS_WORKFLOW, ADVANCED_INVOICING, ADVANCED_INVOICING_GENERATE, ACCOUNTING_PERIODS, ACCOUNTING_PERIODS_DETAILS, ACCOUNTING_PERIODS_LOCK, ACCOUNTING_PERIODS_OPEN_CLOSE, GENERAL_LEDGER, GENERAL_LEDGER_STAFF, REPORT_TEMPLATE, ARTICLES, ARTICLES_DETAILS, PURCHASE_INVOICES_SCAN, PURCHASE_INVOICES_SCAN_DETAILS, RECOGNIZER, BALANCE, BALANCE_SHEET, BALANCE_SHEET_STAFF, PL_REPORT, PL_REPORT_STAFF, CASH_FLOW_REPORT, MY_TIMESHEETS, MY_ACCOUNT, TIME_DETAILS, TIME_DETAILS_DETAILS, TIME_DETAILS_WORKFLOW, TEAM_REVIEW, BUDGETING, BUDGETING_DETAILS, SALARY_CONFIG, SALARY_CONFIG_DETAILS, RECEIVABLES, PAYABLES, PAYABLES_PAYMENT_FILE, PDF_TEMPLATES, PDF_TEMPLATES_DETAILS, DASHBOARD, LATE_NOTICES, MY_PAYROLL, PAYROLL, PAYROLL_DETAILS, PAYROLL_ACCOUNTING, VAT_REPORT, ORDER_REPORTS, ORDER_REPORTS_DETAILS, RATIOS_REPORT, VACATIONS, TRASH_CAN, USER_GROUPS, USER_GROUPS_DETAILS, WORKFLOW, WORKFLOW_DETAILS, MY_WORKFLOW_NOTIFICATIONS, FIXED_ASSETS, UNASSIGNED, EXPENSES, EXPENSES_DETAILS, EXPENSES_DRAFT, EXPENSES_DRAFT_DETAILS, CONTACT_BALANCE_REPORT, ORGANIZATION_CURRENCIES, ORGANIZATION_CURRENCIES_DETAILS, or FINANCIAL_STATEMENTS.
name string

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- items array[object]
  
  Hide items attributes Show items attributes object
  
  error boolean
  
  errorCode object
  
  Hide errorCode attributes Show errorCode attributes object
  
  errorCode string
  
  Values are NO_ERROR, NOT_IMPLEMENTED_YET, CONTACT_NOT_FOUND, FIELD_REQUIRED, VALIDATION_ERROR, DUPLICATION_ERROR, UNIQUE_CONSTRAINT_VIOLATION, WRONG_PASSWORD_FORMAT, WRONG_PASSWORD, ACTION_DENIED, NOT_FOUND, EXPECTED_ONE_FILE, UNIQUE_VIOLATION, CONTENT_EMPTY, INVALID_TYPE, CONVERSION_ERROR, FILE_PARSE_EXCEPTION, or IN_USE.
  
  errorDetailValues array[object]
  
  Hide errorDetailValues attributes Show errorDetailValues attributes object
  
  data string
  
  errorCode string
  
  fieldName string
  
  isSevere boolean
  
  freshData object
  
  freshRow object
  
  possibleWorkflows array[object]
  
  Hide possibleWorkflows attributes Show possibleWorkflows attributes object
  
  id integer
  
  name string
  
  severeError boolean
400

Error
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

POST /api-v1/workflow/batch

curl \
 --request POST 'https://wyzio.app/api-v1/workflow/batch' \
 --header "Content-Type: application/json" \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string" \
 --data '[{"blocks":[{"actionType":"ADVANCED_INVOICING","blockType":"TRIGGER","canModify":true,"contacts":[{"email":"string","id":42,"name":"string"}],"filters":"string","generateParams":"string","id":42,"isSystemUserGroup":true,"isSystemUserGroup2":true,"position":42,"userGroupIds":[42],"userGroupIds2":[42],"users":[{"email":"string","id":42,"name":"string"}],"users2":[{"email":"string","id":42,"name":"string"}]}],"description":"string","id":42,"isActive":true,"moduleType":"ALL","name":"string"}]'

Request examples

# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string

# Payload
[
  {
    "blocks": [
      {
        "actionType": "ADVANCED_INVOICING",
        "blockType": "TRIGGER",
        "canModify": true,
        "contacts": [
          {
            "email": "string",
            "id": 42,
            "name": "string"
          }
        ],
        "filters": "string",
        "generateParams": "string",
        "id": 42,
        "isSystemUserGroup": true,
        "isSystemUserGroup2": true,
        "position": 42,
        "userGroupIds": [
          42
        ],
        "userGroupIds2": [
          42
        ],
        "users": [
          {
            "email": "string",
            "id": 42,
            "name": "string"
          }
        ],
        "users2": [
          {
            "email": "string",
            "id": 42,
            "name": "string"
          }
        ]
      }
    ],
    "description": "string",
    "id": 42,
    "isActive": true,
    "moduleType": "ALL",
    "name": "string"
  }
]

Response examples (200)

{
  "items": [
    {
      "error": true,
      "errorCode": {
        "errorCode": "NO_ERROR",
        "errorDetailValues": [
          {
            "data": "string",
            "errorCode": "string",
            "fieldName": "string",
            "isSevere": true
          }
        ]
      },
      "freshData": {},
      "freshRow": {},
      "possibleWorkflows": [
        {
          "id": 42,
          "name": "string"
        }
      ],
      "severeError": true
    }
  ]
}