Update a contact

Updates a contact for a specified account.

You can update contacts for cancelled accounts.

Request
path Parameters
contactId
required
string

The ID of the contact that you want to update.

header Parameters
Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Request Body schema: application/json
required
address1
string <= 255 characters

The first line of the contact's address, which is often a street address or business name.

address2
string <= 255 characters

The second line of the contact's address.

city
string <= 40 characters

The city of the contact's address.

contactDescription
string <= 100 characters

A description for the contact.

country
string <= 64 characters

The country of the contact's address.

county
string <= 32 characters

The county. May optionally be used by Zuora Tax to calculate county tax.

fax
string <= 40 characters

The contact's fax number.

firstName
string <= 100 characters

The contact's first name.

homePhone
string <= 40 characters

The contact's home phone number.

lastName
string <= 100 characters

The contact's last name.

mobilePhone
string <= 100 characters

The mobile phone number of the contact.

nickname
string <= 100 characters

A nickname for the contact.

otherPhone
string <= 40 characters

An additional phone number for the contact.

otherPhoneType
string

The type of the additional phone number.

Enum: "Work" "Mobile" "Home" "Other"
personalEmail
string <= 80 characters

The contact's personal email address.

state
string <= 40 characters

The state or province of the contact's address.

taxRegion
string <= 32 characters

If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.

workEmail
string <= 74 characters

The contact's business email address.

workPhone
string <= 40 characters

The contact's business phone number.

zipCode
string <= 20 characters

The zip code for the contact's address.

property name*
additional property
any

Custom fields of the Contact object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Custom Fields for more information.

Responses
200
500

Internal Server Error

4XX

Request Errors

put/v1/contacts/{contactId}
Request samples
application/json
{
  • "address1": "new Address",
  • "city": "Mumbai",
  • "contactDescription": "This is the new Description",
  • "mobilePhone": 123213,
  • "zipCode": 123134
}
Response samples
application/json
{
  • "accountId": "6e767220676e6e61206d616b65207520637279",
  • "accountNumber": "A00000001",
  • "address1": "new Address",
  • "address2": "near Tech City",
  • "city": "Mumbai",
  • "contactDescription": "This is the new Description",
  • "country": "India",
  • "county": null,
  • "fax": "6174",
  • "firstName": "Kuhi",
  • "homePhone": "1234123",
  • "id": "8a90f50888a3036e0188ab7b3ffe7b8a",
  • "lastName": "Das",
  • "mobilePhone": "123213",
  • "nickname": "Dorimi",
  • "otherPhone": "2314213",
  • "otherPhoneType": "Work",
  • "personalEmail": "kuhiroll@example.com",
  • "state": "Assam",
  • "success": true,
  • "taxRegion": null,
  • "workEmail": null,
  • "workPhone": null,
  • "zipCode": "123134"
}