Skip to main content
Suppliers API

updateSupplier

updateSupplier

Overview

This API replicates the system function of the suppler.
Visit Suppliers to see the feature

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.
If you are not actively using the API, leave the permission off for better security.
Go to Roles / Apis and check on Suppliers:Update.

Authentication

Authenticate with the API before running this API.

HTTP Method

Use the HTTP Method 'PUT' for consuming this web service.

URL Examples

https://api.test.catch-e.com/fm/suppliers/100509

Path Variables

Key

Format

Notes

Mandatory

supplier_id

string

To update the supplier details.

Required

Headers

Key

Format

Notes

Mandatory

Audit-User-Id

string

User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Optional

Delegated-Locking-Session-Id

string

Untested variable.

Optional

Body

{ "supplier_code": "VIC", "email": "text@gmail.com" }

Response Details

401 - Unauthorized

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

You have not authenticated before running this API or the token_timeout of the current session has passed. You need to authenticate again.

403 Forbidden

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

422 - Unprocessable Entity

"emailAddressInvalidFormat": "The input is not a valid email address. Use the basic format local-part@hostname"

Invald email address

Was this helpful?

Still need help? Ask the team