OmnioDocsAPI referenceOpen the app

Change mapping

PATCH/v1/import-mappings/{mapping_id}

Change a mapping's name, format or columns.

Jobs already made keep the mapping they ran with.

Scope imports:write

Path parameters

mapping_idstring, uuidRequired

Request body

namestring
1 to 80 characters
formatenum
One of csv, json
mappingobject

Response

  • 200Success
Response fields
idstringRequired
namestringRequired
formatstringRequired
mappingobjectRequired
created_atstringRequired
updated_atstringRequired

Errors

  • 401unauthorized. The key is missing, unknown or revoked
  • 403insufficient_scope. The key lacks the scope above
  • 403forbidden, or insufficient_scope
  • 404not_found
  • 409mapping_exists
  • 422validation_error, or mapping_invalid

Every error has the same shape. See Errors.