Skip to main content

Update Customer

PATCH /customers/{customer_id}

Update a customer.

Roles​

Users with the following roles may access this endoint:

Dispatcher

Breaking Changes​

No breaking changes.

Request​

PATCH /customers/{customer_id}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}
{
"name": "Test Update"
}

Path Parameters​

customer_id Integer, Required

Customer identifier.

Query Parameters​

note

No query parameters.

Request Headers​

Refer to StandardRequestHeadersModel for more details.

authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

  • Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
  • No longer than 256 characters.
  • At least 1 characters long.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

x-api-version String, Optional

Request identifier.

  • At least 1 and no more than 64 characters.
  • Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

x-tenant-id Integer, Required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

Request Body​

Refer to UpdateCustomerModel for more details.

name String, Optional

Name (free text).

  • At least 1 and no more than 64 characters.

parent_id Integer, Optional

Parent record identifier.

Response​

Response Headers​

Refer to StandardResponseHeadersModel for more details.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

x-api-version String

Request identifier.

  • At least 1 and no more than 64 characters.
  • Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

x-request-id String

Request identifier.

  • Valid UUID.

Response Body​

Refer to CustomerModel for more details.

addresses Array[CustomerAddressModel]

Refer to CustomerAddressModel.

contacts Array[CustomerContactModel]

Refer to CustomerContactModel.

created_on String

Timestamp of creation (must be in past).

  • Date occurring in the past in an ISO 8601 compatible format.

id Integer

Customer identifier.

last_updated_on String

  • Date occurring in the past in an ISO 8601 compatible format.

locations Array[DispatchCustomerSettingsModel]

Refer to DispatchCustomerSettingsModel.

name String

Name (free text).

  • At least 1 and no more than 64 characters.

parent_id Integer

Parent record identifier.

Code Samples​

using System;
using System.Net;
using System.Collections.Specialized;

namespace CROSoftware
{
public class DemoClient
{
    static public void Main ()
    {
        WebClient client = new WebClient();

        // URL    
        String url = "/customers/{customer_id}";

        // Headers
        client.Headers.Add("Authorization", "Bearer {your-auth-token}");
        client.Headers.Add("Content-Type", "application/json");
        client.Headers.Add("x-tenant-id", "{your-tenant-id}");

        // Body
        String body = "{\"name\": \"Test Update\"}";

        String json = client.UploadString(url, "patch", body);
        Console.WriteLine(json);
    }
}
}