CRUD: Create a contact

Creates a contact for a specified account.

Request
query Parameters
rejectUnknownFields
boolean
Default: false

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

header Parameters
Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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 do not need to set this header.

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
AccountId
required
string

The Zuora account ID associated with this contact. This field is not required when you use the Subscribe call. This field is required for all other calls. **Character limit: **32 **Values: **a valid account ID

Address1
string

The first line of the contact's address, which is often a street address or business name. Character limit: 255 Values: a string of 255 characters or fewer

Address2
string

The second line of the contact's address. Character limit: 255 Values: a string of 255 characters or fewer

City
string

The city of the contact's address. Character limit: 40 **Values: **a string of 40 characters or fewer

Country
string

The country of the contact's address.

County
string

The county. May optionally be used by Zuora Tax to calculate county tax. Character limit: 32 Values: a string of 32 characters or fewer

Description
string

A description for the contact. Character limit: 100 Values: a string of 100 characters or fewer

Fax
string

The contact's fax number. Character limit: 40 Values: a string of 40 characters or fewer

FirstName
required
string

The contact's first name. Character limit: 100 Values: a string of the contact's first name

HomePhone
string

The contact's home phone number. Character limit: 40 Values: a string of 40 characters or fewer

LastName
required
string

The contact's last name. Character limit: 100 Values: a string of 100 characters or fewer

MobilePhone
string

The contact's mobile phone number. Character limit: 40 Values: a string of 40 characters or fewer

NickName
string

A nickname for the contact. Character limit: 100 Values: a string of 100 characters or fewer

OtherPhone
string

An additional phone number for the contact. Character limit: 40 Values: a string of 40 characters or fewer

OtherPhoneType
string

The type of the OtherPhone. Character limit: 20 Values: Work, Mobile, Home, Other

PersonalEmail
string

The contact's personal email address. Character limit: 80 Values: a string of 80 characters or fewer

PostalCode
string

The zip code for the contact's address. Character limit: 20 **Values: **a string of 20 characters or fewer

State
string

The state or province of the contact's address.

TaxRegion
string

If using Zuora Tax rules

WorkEmail
string

The contact's business email address. Character limit: 80 Values: a string of 80 characters or fewer

WorkPhone
string

The contact's business phone number. Character limit: 40 notes: -- Values: a string of 40 characters or fewer

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 Manage Custom Fields for more information.

Responses
200
400
401
post/v1/object/contact
Request samples
application/json
{
  • "AccountId": "8ad09be48db5aba7018db604776d4854",
  • "FirstName": "Amy",
  • "LastName": "Lawrence"
}
Response samples
application/json
{
  • "Success": true,
  • "Id": "2c93808457d787030157e03220684fac"
}