PUT /v1/contacts/{contactId}

Updates a contact for a specified account.

You can update contacts for cancelled accounts.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Path parameters

Name	Type	Required	Description
`contactId`	String	Yes	The ID of the contact that you want to update.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	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.
`Zuora-Track-Id`	String	No	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 (`'`).
`Authorization`	String	No	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	No	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 do not need to set this header.
`Zuora-Org-Ids`	String	No	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.
`Accept-Encoding`	String	No	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.

Request body fields

Name	Type	Required	Description
`personalEmail`	String	No	The contact's personal email address.
`address2`	String	No	The second line of the contact's address.
`address1`	String	No	The first line of the contact's address, which is often a street address or business name.
`homePhone`	String	No	The contact's home phone number.
`state`	String	No	The state or province of the contact's address.
`zipCode`	String	No	The zip code for the contact's address.
`otherPhoneType`	String	No	The type of the additional phone number. Possible values: `"Other"` `"Mobile"` `"Work"` `"Home"`
`city`	String	No	The city of the contact's address.
`workEmail`	String	No	The contact's business email address.
`contactDescription`	String	No	A description for the contact.
`fax`	String	No	The contact's fax number.
`nickname`	String	No	A nickname for the contact.
`workPhone`	String	No	The contact's business phone number.
`lastName`	String	No	The contact's last name.
`mobilePhone`	String	No	The mobile phone number of the contact.
`otherPhone`	String	No	An additional phone number for the contact.
`taxRegion`	String	No	If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.
`firstName`	String	No	The contact's first name.
`country`	String	No	The country of the contact's address.
`county`	String	No	The county. May optionally be used by Zuora Tax to calculate county tax.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.