Update a Customization

Last edit: 

Contributors: 

To update a customization, send a PUT request to /api/user/customizations/:customization_id

HTTP request

PUT /api/user/customizations/:customization_id

Parameters

Parameter Type Description Required Notes
form_configuration_name String Name of the form configuration Required
form CustomizationForm CustomizationForm parameters that corresponds with FormConfiguration configuration Required

Customization Parameters

Parameter Type Description Required Notes
custom_addresses Hash[String=>CustomAddressForm] Custom addresses for this resource Optional
custom_attachments Hash[String=>CustomAttachmentForm] Custom attachments for this resource, such as pdf, doc Optional
custom_images Hash[String=>CustomImageForm] Custom images for this resource Optional
customizable_id Integer Numeric identifier for the object to which the customization is attached Optional
customizable_type String Type of the object to which the customization is attached. Valid values: User UserProfile Transactable Offer Order Instance Reservation Relationship Optional used in conjunction with customizable_id
customizations Hash[String=>CustomizationForm] Customizations for this resource Optional
id Integer Numeric identifier of the associated object Optional
properties Hash[String=>Any] Custom properties Optional
user_id Integer Numeric identifier for the object to which the customization is attached Optional

Example request

"authorization: Token token=[YOUR API TOKEN]"
"accept: application/json"
"content-type: application/json"

{
  "form_configuration_name": "reference_rest_api_update_customization",
  "form": {
    "properties": {
      "url": "aol.com"
    }
  }
}
Element Type Description Required?
form_configuration_name String Name of the defined FormConfiguration Required
form CustomizationForm Attributes for user, should match configuration defined in corresponding FormConfiguration Required

Example response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{}

Element Type Description
[…] […] […]

Error and Status Codes

Code Message Meaning
204 No Content Successfully fulfilled request
401 Unathorized Invalid Authentication
404 Not Found Can't find given resource
406 Not Acceptable Wrong parameters passed