Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Contacts API

A contact defines the customer who holds an account or who is otherwise a person to contact about an account. An account requires a contact for the `BillToId` and `SoldToId` fields before the account can be active.

Zuora Contacts API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

5 operations 3 paths 5 schemas 1 DELETE1 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Contacts 5

A contact defines the customer who holds an account or who is otherwise a person to contact about an account. An account requires a contact for the BillToId and SoldToId fields be…

PUT
/v1/contacts/{contactId}/scrub
Scrub a contact
PUT_ScrubContact 7 params → 200
POST
/v1/contacts
Create a contact
POST_CreateContact 8 params → 200
GET
/v1/contacts/{contactId}
Retrieve a contact
GET_Contact 7 params → 200
PUT
/v1/contacts/{contactId}
Update a contact
PUT_Contact 8 params → 200
DELETE
/v1/contacts/{contactId}
Delete a contact
DELETE_Contact 7 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed is CommonResponseType (3 properties). Each schema is shown below with its type and property counts.

PUTContactType
ContactResponse
CommonResponseType
object
3 properties
POSTContactType
ContactObjectCustomFields
object
Container for custom fields of a Contact object.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-contacts-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API