PATCH/desk/api/v2/customers/{id}.json

Update a customer.

Update all the given properties for this resource. Any omitted properties will be unchanged. Customers can be added to a customer via the 'includes: customers' field. Customers can be removed by speecifying 'delete: true' on the customers: [] relationship.

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Body Params

CustomerAPIBody is the request/response format for the API

    • Name
      customer
      Type
      object
      Description
      Customer represents a Customer.
    • Name
      included
      Type
      object
      Description
      Included allows adding referenced objects on the API response. The included keys should map to the `types` in the Relationship slices/objects.

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      CustomerAPIBody is the request/response format for the API
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    200 OK

    CustomerAPIBody
    {  "customer": {    "addMethod": "string",    "address": "string",    "avatarURL": "string",    "company": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "contacts": [      {        "delete": true,        "id": 0,        "meta": {