Partially update ACME contract

5 minute read

PATCH https://www.digicert.com/partner-subscription/api/v1/acme/{{acme_contract_id}}

Use this endpoint to partially update an existing ACME contract.

Unlike the PUT endpoint, this endpoint updates only the fields included in the request body. Omitted fields retain their current values. Use this endpoint to update auto_renew without changing organization data, or to update organization data without updating the entire ACME contract.

Use the PATCH endpoint when you want to update specific ACME contract fields and preserve omitted values. For example, you can update only the auto_renew setting without resubmitting the organization object.

Changing organization information rejects existing organization validation. Certificate issuance is blocked until revalidation is complete.

The following changes reject organization validation:

Organization name changes.
Address changes, including address, address2, city, state, zip, or country.
Other organization field changes, except contacts.

The following changes do not reject organization validation:

Updating organization_contact.
Updating technical_contact.
Adding verified_contacts for EV contracts.

If multiple ACME contracts on your account use the same organization details, changing the organization information invalidates validation for all affected contracts. All affected contracts must complete revalidation before certificates can be issued.

Before updating organization information, confirm that the changes are necessary. Updating organization details can require revalidation for all ACME contracts that use the corresponding organization, which may delay certificate issuance across those contracts.

Example requests and responses

curl -X PATCH \
  https://www.digicert.com/partner-subscription/api/v1/acme/12345 \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-APIKEY: {{subaccount_partner_api_key}}' \
  -d '{
    "auto_renew": true
}'

curl -X PATCH \
  https://www.digicert.com/partner-subscription/api/v1/acme/12345 \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-APIKEY: {{subaccount_partner_api_key}}' \
  -d '{
    "organization": {
      "organization_contact": {
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "jane@example.com",
        "telephone": "+1-555-0200",
        "job_title": "Senior IT Director"
      }
    }
}'

curl -X PATCH \
  https://www.digicert.com/partner-subscription/api/v1/acme/12345 \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-APIKEY: {{subaccount_partner_api_key}}' \
  -d '{
    "auto_renew": true,
    "organization": {
      "name": "Example Corp",
      "address": "456 New St",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94105",
      "country": "US",
      "organization_contact": {
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "jane@example.com",
        "telephone": "+1-555-0200"
      }
    }
}'

204 No Content

The ACME contract was updated successfully. The response does not include a body.

URL path and query parameters

Name	Req/Opt	Type	Description
acme_contract_id	required	integer	Unique identifier of the ACME contract to partially update.

Request parameters

Name	Req/Opt	Type	Description
auto_renew	optional	boolean	Enable or disable auto-renewal for the ACME contract. If omitted, the current `auto_renew` value is preserved. Use this endpoint to change the auto-renewal setting after the ACME contract is created. To configure renewal behavior during subscription creation, set `auto_renew` while creating an ACME contract.
organization	optional	object	Object with organization details to update for the ACME contract. Only the organization fields included in the request are updated; omitted organization fields retain their current values. Note: Organization updates apply to OV and EV contracts only.
.. assumed_name	optional	string	Assumed name or public name of the organization. Also called Doing Business As (DBA) name. Note: Updating this value may require organization revalidation if it changes the organization information used for validation.
.. name	optional	string	Legal name of the organization. Note: Updating the organization name rejects existing organization validation and requires revalidation.
.. address	optional	string	Address of the organization. Note: Updating the organization address rejects existing organization validation and requires revalidation.
.. address2	optional	string	Second line of the organization's address. Additional address information, such as suite, floor, or unit. Note: Updating this value rejects existing organization validation and requires revalidation.
.. city	optional	string	City where the organization is located. Note: Updating the city rejects existing organization validation and requires revalidation.
.. state	optional	string	State or province where the organization is located. Use the full name instead of an abbreviation. Note: Updating the state or province rejects existing organization validation and requires revalidation.
.. zip	optional	string	Postal or ZIP code where the organization is located. Note: Updating the postal or ZIP code rejects existing organization validation and requires revalidation.
.. country	optional	string	Two-letter country code where the organization is located. Note: Updating the country rejects existing organization validation and requires revalidation.
.. telephone	optional	string	Organization phone number.
.. organization_contact	optional	object	Primary organization contact for the organization. Include this object to add or replace the organization contact. Note: Updating the organization contact does not reject existing organization validation.
.. technical_contact	optional	object	Technical contact for the organization. Include this object to add or replace the technical contact. Note: Updating the technical contact does not reject existing organization validation.
.. verified_contacts	optional	array[object]	Verified contacts for EV contracts. Include this array to add or replace verified contacts. Note: Adding verified contacts for EV contracts does not reject existing organization validation.
.. .. first_name	conditional	string	First name of the new organization, technical, or verified contact. Note: Required when adding or replacing a contact.
.. .. last_name	conditional	string	Last name of the new organization, technical, or verified contact. Note: Required when adding or replacing a contact.
.. .. email	conditional	string	Email address of the new organization, technical, or verified contact. Note: Required when adding or replacing a contact.
.. .. telephone	conditional	string	Telephone number of the new organization, technical, or verified contact. Note: Required when adding or replacing a contact.
.. .. job_title	conditional	string	Job title of the new organization, technical, or verified contact. Note: Required when adding or replacing a verified contact for EV contracts. Optional for organization and technical contacts.

For OV contracts, organization contacts and technical contacts can be updated with the organization.organization_contact and organization.technical_contact objects. For EV contracts, verified contacts can be updated with the organization.verified_contacts array. Technical contacts are optional.