Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Subscription API

Update Contact

Updates the customer's subscription profile, such as the email address, billing address, delivery address, and licensee address. The updates will be reflected on the next billing date.<br />For more information, see Update Contact. For XML examples and schemas, see the Additional Examples - Update Contact.

post/subscription/updatecontact

Headers

Accept'application/json' | 'application/xml'

Expected response format.

Content-Type'application/json' | 'application/xml'

Format of the HTTP post body.

Request body

ContactType'LicenseeContact' | 'BillingContact' | 'DeliveryContact' required

The type of contact information you want to update. One customer can have up to three different types of contact information.

CustomerReferenceIdstring

Your unique ID of the customer. This value is submitted by you when the customer initially purchases the subscription and is stored by Cleverbridge. Corresponds to the <b>Internal customer ID</b> in the Cleverbridge platform. For more information, see Customer Data.

OverrideEmptyParametersboolean

Set to <code>true</code> if you want to delete omitted parameters from the contact information.

SubscriptionIdstring

Unique ID of the contact's subscription, with or without an initial 'S'.

SplitContactsboolean

Set to <code>true</code> to split up contact of given type to its own entity if not already

Response

OK

ResultMessagestring

Optional result or error message.