Skip to main content

Update Contact

PATCH /customers/{customer_id}/contacts/{customer_contact_id}

Update a customer contact.

Roles​

Users with the following roles may access this endoint:

Dispatcher

Breaking Changes​

No breaking changes.

Request​

PATCH /customers/{customer_id}/contacts/{customer_contact_id}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}
{
"email": "test.updated@contacts.com"
}

Path Parameters​

customer_contact_id Integer, Required

Customer contact identifier.

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 UpdateCustomerContactModel for more details.

email String, Optional

Email address comma-separated list.

  • At least 0 and no more than 256 characters.
  • List of 1 or more comma-separated email addresses. Whitespace allowed (newline, space, tab).

fax String, Optional

Fax number (free text).

  • At least 7 characters, not more than 15.

name String, Optional

Name (free text).

  • At least 1 and no more than 128 characters.

notify_on_acknowledged_request Boolean, Optional

Notify on acknowledge request.

  • One of 0, 1, True, False (case insensitive).

notify_on_completed_request Boolean, Optional

Notify on completed request.

  • One of 0, 1, True, False (case insensitive).

notify_on_dispatched_request Boolean, Optional

Notify on dispatched request.

  • One of 0, 1, True, False (case insensitive).

notify_on_failed_request Boolean, Optional

Notify on failed request.

  • One of 0, 1, True, False (case insensitive).

notify_on_new_request Boolean, Optional

Notify on new request.

  • One of 0, 1, True, False (case insensitive).

number String, Optional

Phone number (free text).

  • At least 1 and no more than 90 characters.

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 CustomerContactModel for more details.

email String

Email address comma-separated list.

  • At least 0 and no more than 256 characters.
  • List of 1 or more comma-separated email addresses. Whitespace allowed (newline, space, tab).

fax String

Fax number (free text).

  • At least 7 characters, not more than 15.

id Integer

Customer contact identifier.

name String

Name (free text).

  • At least 1 and no more than 128 characters.

notify_on_acknowledged_request Boolean

Notify on acknowledge request.

  • One of 0, 1, True, False (case insensitive).

notify_on_completed_request Boolean

Notify on completed request.

  • One of 0, 1, True, False (case insensitive).

notify_on_dispatched_request Boolean

Notify on dispatched request.

  • One of 0, 1, True, False (case insensitive).

notify_on_failed_request Boolean

Notify on failed request.

  • One of 0, 1, True, False (case insensitive).

notify_on_new_request Boolean

Notify on new request.

  • One of 0, 1, True, False (case insensitive).

number String

Phone number (free text).

  • At least 1 and no more than 90 characters.

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}/contacts/{customer_contact_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 = "{\"email\": \"test.updated@contacts.com\"}";

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