ERerply
Attributes

Attach / Update an Attribute

To Create an attribute you must leave the id field empty. To Update you must specify the ID field. RecordID refers to the object that the attribute will be attached to. Supported entities: 'customer', 'customer group', 'address'. Name cannot have spaces and is limited to 50 characters. One database record must not have multiple attributes with the same name. 3 types are available - int, double, text. Based on the type the value should be number of text.

put/v1/attributes

Request

  • Base URL
    (relative, and it does not resolve against the document’s source URL)
  • Auth
    • API key in header sessionKey
    • or API key in header clientCode
    • or API key in header jwt
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

entitystring

Entity name of the record

idinteger

ID of the attribute

namestring

name of the attribute

record_idinteger

ID of the record

typestring

3 types are available - int, double, text

valueunknown

Example request

{
  "entity": "customer group",
  "name": "is_good",
  "record_id": 7,
  "type": "int"
}

Response

Created

idinteger

Example response

{
  "id": 73
}

Changes

No recorded changes to this operation across all 1 revision of this API.