Skip to main content

WriteResults

results object[]
  • Array [
  • indexinteger

    Position in the request

    statusstring

    Possible values: [created, updated, unchanged, deleted, not_found, rejected, not_applied]

    idstring
    changedstring[]

    updated: the fields (and child collections) that changed

    errors object[]
  • Array [
  • pathstring
    Example: [3].locations[0].bank_accounts[1].swift_code
    codestring
    Example: invalid_value
    messagestring
  • ]
  • warnings object[]
  • Array [
  • codestring
    messagestring
  • ]
  • ]
  • summary object
    property name*integer
    WriteResults
    {
    "results": [
    {
    "index": 0,
    "status": "created",
    "id": "string",
    "changed": [
    "string"
    ],
    "errors": [
    {
    "path": "[3].locations[0].bank_accounts[1].swift_code",
    "code": "invalid_value",
    "message": "string"
    }
    ],
    "warnings": [
    {
    "code": "string",
    "message": "string"
    }
    ]
    }
    ],
    "summary": {
    "created": 2,
    "updated": 1,
    "unchanged": 5
    }
    }