--- title: Create Fields Sync Job slug: create-fields-sync-job docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "Nur4cYek4AUWN1CaR9TQc", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.nue.io/orders/fields-sync-jobs", "servers": [ { "url": "https://api.nue.io/orders/fields-sync-jobs", "description": "Nue Production API Endpoint" }, { "url": "https://api.sandbox.nue.io/orders/fields-sync-jobs", "description": "Nue Sandbox API Endpoint" } ], "name": "Create Fields Sync Job", "description": "

Create a job to sync selected fields from CRM (Salesforce) to Nue

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "*/*", "application/json" ], "default": "*/*" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "SyncJobRequestFieldsSyncParam", "schema": [ { "name": "parameters", "kind": "optional", "type": "object", "description": "

The additional parameters of the batch job, currently only ‘graphqlFilter’ is supported, set this parameter in the request if only filtered records need to be synced

", "modelRef": "#/components/schemas/FieldsSyncParam", "customType": "FieldsSyncParam", "schema": [ { "name": "objectApiName", "kind": "required", "type": "string", "description": "

Object API name, currently supported: Order, Customer, Invoice, InvoiceItem, InvoiceItemDetail, CreditMemo, CreditMemoItem, CreditMemoItemDetail, Customer and RelatedCustomer.

", "example": "Order", "enum": [ "AbstractAsset", "Order", "OrderProduct", "Asset", "AssetOrderProduct", "Contact", "Customer", "Subscription", "UserProfile", "Company", "RelatedCustomer", "BillingSchedule", "BillingJob", "Invoice", "InvoiceItem", "InvoiceItemDetail", "CreditMemo", "CreditMemoItem", "CreditMemoItemDetail", "Usage", "PaymentApplication", "PaymentApplicationItem", "CreditType", "CreditPool", "AccountCreditPool", "Credit", "CreditFlow", "DebitMemo", "DebitMemoItem", "BillingState", "BillingAsset", "PaymentRule", "PaymentMethod", "Entitlement", "Entity", "LinePriceDimension", "PriceDimension", "FeaturePriceDimension", "PriceBook", "PriceTier", "ProductOptionPriceDimension", "ProductPriceDimension", "UOM", "Feature", "BundleSuite", "PriceBookEntry", "Product", "ProductOption", "ProductFeature", "BundleSuiteBundle", "CreditConversion", "ProductOptionRelation", "ChangeHistory", "SsSubscription", "SsAsset", "SsEntitlement", "FormTemplate", "Quote", "Opportunity", "Contract", "Account", "Pricebook2", "User" ] }, { "name": "fieldApiNames", "kind": "required", "type": "array", "description": "Fields expected to be synced. ", "example": "[\"IsReseller__c\",\"orderACV\",\"paymentMethod\",\"description\",\"poNumber\"]", "itemType": "string", "customType": "string[]", "itemExample": "[\"IsReseller__c\",\"orderACV\",\"paymentMethod\",\"description\",\"poNumber\"]", "itemDefault": "" }, { "name": "graphqlFilter", "kind": "optional", "type": "string", "description": "Define conditions for the records to be synced in graphql. ", "example": "{ IsReseller__c: { _eq : false } }" } ] }, { "name": "batchSize", "kind": "optional", "type": "integer", "description": "

The size of each batch in the current job, this parameter is passed from the request

", "format": "int64" }, { "name": "scheduleId", "kind": "optional", "type": "string", "description": "

The schedule Id if the current batch job is triggered by a scheduled job, this parameter is passed from the request

" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the current batch job" } ], "modelRef": "#/components/schemas/SyncJobRequestFieldsSyncParam", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Created", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "zaSVrpTrxSGbn4o2zzOsn", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/orders/fields-sync-jobs \\\n --header 'accept: */*' \\\n --header 'content-type: application/json' \\\n --data '{\n \"parameters\": {\n \"objectApiName\": \"Order\",\n \"fieldApiNames\": []\n }\n }'" }, { "id": "29ItS1yWxmbP3-sUeNAwc", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"*/*\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"parameters\": {\n \"objectApiName\": \"Order\",\n \"fieldApiNames\": []\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/orders/fields-sync-jobs\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "f7Ye3Vgfh-OvdDAmn_Y9_", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/orders/fields-sync-jobs\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"*/*\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"parameters\": {\n \"objectApiName\": \"Order\",\n \"fieldApiNames\": []\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "fhh-uEQrgqokrpOenqB9g", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/orders/fields-sync-jobs\"\n\npayload = json.dumps({\n \"parameters\": {\n \"objectApiName\": \"Order\",\n \"fieldApiNames\": []\n }\n})\nheaders = {\n 'accept': '*/*',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "zaSVrpTrxSGbn4o2zzOsn" }, "results": { "languages": [ { "id": "M_G1Y2U-dx9ksAAkHTjhQ", "language": "201", "code": "// Created\n" }, { "id": "3O8bly99cnI09ICyo9wzn", "language": "400", "code": "// Bad Request\n{\n \"title\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\"\n}" }, { "id": "WVQoHT48HT_gwABC2fJAY", "language": "404", "code": "// Not Found\n" } ], "selectedLanguageId": "M_G1Y2U-dx9ksAAkHTjhQ" } }, "children": [ { "text": "" } ] }