Update custom fields

PATCH 
/clients/custom_fields/:id

JSON-RPC

clients.custom_fields.update

The method allows extra fields to be provided according to the the custom fields definition. The name of the field should be equal to the key of the custom field definition.

Request

Path Parameters

id integerrequired

Client ID.

Responses

200

Number of the affected rows.

application/json

Schema

Schema

integerinteger

400

The request contains invalid arguments or is malformed

application/json

Schema

Schema

error object
messagestring
Error message
Example: Invalid request
dataobject
Details for validation errors (if applicable)
Example: {"name":"Empty value is not allowed","payment_terms_id":"Object \"payment_terms(123)\" was not found!"}

Example (auto)

{
  "error": {
    "message": "Invalid request",
    "data": {
      "name": "Empty value is not allowed",
      "payment_terms_id": "Object \"payment_terms(123)\" was not found!"
    }
  }
}

401

Access is not authorized

application/json

Schema

Schema

error object
messagestring
Example: utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed
data object
codestring
Error code
Example: utoken-auth-failed
messagestring
Example: Authentication Failed: IP 10.0.0.1 is not allowed

Example (auto)

{
  "error": {
    "message": "utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed",
    "data": {
      "code": "utoken-auth-failed",
      "message": "Authentication Failed: IP 10.0.0.1 is not allowed"
    }
  }
}

404

Requested object was not found

application/json

Schema

Schema

error object
messagestring
Example: not_found: Object "clients(123)" was not found!
data object
codestring
Error code (static: not_found)
Example: not_found
messagestring
Error message
Example: Object "clients(123)" was not found!
object_namestring
Type of the object
Example: clients
object_idstring
ID of the object
Example: 123

Example (auto)

{
  "error": {
    "message": "not_found: Object \"clients(123)\" was not found!",
    "data": {
      "code": "not_found",
      "message": "Object \"clients(123)\" was not found!",
      "object_name": "clients",
      "object_id": "123"
    }
  }
}

422

A logical error occurred, making the request unprocessable

application/json

Schema

Schema

error object
messagestring
Error message
Example: invoices-zero-amount: Impossible to create an invoice with zero amount
data object
codestring
Error code
Example: invoices-zero-amount
messagestring
Error message
Example: Impossible to create an invoice with zero amount

Example (auto)

{
  "error": {
    "message": "invoices-zero-amount: Impossible to create an invoice with zero amount",
    "data": {
      "code": "invoices-zero-amount",
      "message": "Impossible to create an invoice with zero amount"
    }
  }
}

500

An unexpected error occurred

application/json

Schema

Schema

error object
messagestring
Error message
Example: An unexpected error occurred

Example (auto)

{
  "error": {
    "message": "An unexpected error occurred"
  }
}

Authorization: X-Api-Key

name: X-Api-Keytype: apiKeyin: headerdescription: Token for API access

• curl
• python
• nodejs
• php

• CURL

curl -L -X PATCH 'https://docs.jerasoft.net/clients/custom_fields/:id' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'

Request Collapse all

Auth

ApiKeyAuth

Parameters

id — pathrequired