INinvoiceninja
designs

Updates a design

Changed on

Handles the updating of a design by id

put/api/v1/designs/{id}

Request

Path parameters

idstring string required

The Design Hashed ID

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

Returns the design object

idstring

The design hashed id

namestring

The design name

designstring

The design HTML

is_customboolean

Flag to determine if the design is a custom user design

is_activeboolean

Flag to determine if the design is available for use

is_deletedboolean

Flag to determine if the design is deleted

created_atnumber

Timestamp

updated_atnumber

Timestamp

deleted_atnumber

Timestamp

Example response

{
  "id": "AS3df3A",
  "name": "Beauty",
  "design": "<html></html>",
  "is_custom": true,
  "is_active": true,
  "is_deleted": true,
  "created_at": 134341234234,
  "updated_at": 134341234234,
  "deleted_at": 134341234234
}

Changes

  • 69a36036d334Revision changes
    • info

      the response optional property became read-only for the status

  • 8e82a2bd77e0Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status