Use the Certificate Center API to retrieve a list of contacts, create contacts, update contacts, and delete contacts.

Base URL:

https://ccservices.vertexsmb.com/certificate-center/v1/

Contacts endpoint	Contacts description
`/customer/{uuid}/contacts`	GET - Retrieve a list of contacts associated to a specified customer based on filter criteria, pagination, and sorting parameters.
`/customer/{uuid}/contact`	POST - Create a contact associated with a specified customer.
`/customer/{uuid}/contact/{contactUuid}`	PUT - Update a contact associated with a specified customer.
`/customer/{uuid}/contact/{contactUuid}`	DEL - Delete a contact associated with a specified customer.

Retrieve customer contacts

Retrieve a list of contacts associated to specified customer based on filter criteria, pagination, and sorting parameters.

Request

A customer UUID request is required. All other parameters are optional. Passing a request with a customer UUID and no parameters returns all available contacts for that customer.

Retrieve customer contacts request parameter name	Retrieve customer contacts request parameter format	Retrieve customer contacts request parameter description
`top`	int64	Number of returned contacts to display per page. Default = 20.
`skip`	int64	Number of contacts to skip before displaying records. Must be 0 or greater. Default = 0.
`filter`	string	Limit the returned records to those including the filter criteria, such as contact name.
`count`	Boolean	If set to true, returns a count of the total contacts found. Default = false.
`orderBy`	string	Order the results according to any response field by entering it here. Results are in alphabetical or numerical order depending on the field format.

Example request

curl --request GET \
     --url https://vertex-enterprise-group.readme.io/certificate-center/v1/customer/uuid/contacts \
     --header 'accept: application/json'

Response

A response includes any number of contacts. Each contact record can include some or all of these fields.

Retrieve customer contacts response field	Retrieve customer contacts response description
`UUID`	Unique identifier.
`name`	Contact name.
`email`	Contact email address.
`postalAddress`	The contact postal address including street address 1, street address 2, city, main division, postal code, and country.
`phone`	Contact phone number.
`phoneExtension`	Contact phone extension.
`department`	Contact fax number.
`emailSubscribedInd`	Indicates whether the email address is subscribed to receive correspondence from Vertex (`true`) or not (`false`).
`primaryInd`	Indicates whether this contact is a parent (`true`) or not (`false`).

Example response

{
  "odata.count": 0,
  "value": [
    {
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "email": "[email protected]",
      "postalAddress": {
        "streetAddress1": "string",
        "streetAddress2": "string",
        "city": "string",
        "mainDivision": "string",
        "postalCode": "string",
        "country": "string"
      },
      "phone": "+1 (123) 456-7890",
      "phoneExtension": "string",
      "fax": "+1-123-4567890x123",
      "department": "string",
      "emailSubscribedInd": true,
      "primaryInd": true
    }
  ]
}

Create a customer contact

Create a contact record associated with a specific customer by providing the customer UUID.

Request parameters

The customer UUID is required as a path parameter.

Create a customer contact parameter name	Create a customer contact parameter format	Create a customer contact parameter description
`UUID`	uuid	Customer UUID.

Supply these request parameters to create a customer contact record. Required parameters are in bold.

Create a customer contact parameter name	Create a customer contact parameter format	Create a customer contact parameter description
`name`	string	Contact name. Must be between 1 and 100 characters.
`email`	string	Contact email address. Must be between 1 and 100 characters.
`streetAddress1`	string	Contact street address 1. Must be between 1 and 100 characters.
`streetAddress2`	string	Street address 2. Must be between 1 and 100 characters.
`city`	string	Contact city. Must be between 1 and 100 characters.
`mainDivision`	string	Contact main division. Must be between 1 and 100 characters.
`postalCode`	string	Contact postal code. Must be between 1 and 100 characters.
`country`	string	Contact country. Must be between 1 and 100 characters.
`phone`	string	Contact phone number. Can include up to 20 characters, with optional country code. This parameter supports separators including space, dash, dot, and parentheses. Extensions are not allowed.
`phoneExtension`	string	Contact phone extension. Can include up to 10 digits, numbers only.
`fax`	string	Contact fax number. Can include up to 20 characters, with optional country code. This parameter supports separators including space, dash, dot, and parentheses. An extension is optional and must start with `x` followed by 1 to 4 digits.
`department`	string	Contact department. Must be between 1 and 100 characters.
`emailSubscribedInd`	Boolean	Indicates whether the email address is subscribed to receive correspondence from Vertex (`true`) or not (`false`).
`primaryInd`	Boolean	Indicates whether this is the primary contact (`true`) or not (`false`).

Example request

curl --request POST \
  --url https://vertex-enterprise-group.readme.io/certificate-center/v1/customer/{customerUuid}/contact \
  --header 'content-type: application/json' \
  --header 'Authorization: Bearer <token>'  
  --data '{
    "name": "Contact1",
    "email": "[email protected]",
    "postalAddress": {
      "streetAddress1": "210 Seaside Boulevard",
      "streetAddress2": "Unit 12B",
      "city": "Citrus Key",
      "mainDivision": "FL",
      "postalCode": "33999",
      "country": "USA"
    },
    "phone": "1-239-555-3852",
    "phoneExtension": "103",
    "fax": "1-239-555-5283",
    "department": "Customer Experience",
    "emailSubscribedInd": true,
    "primaryInd": true
  }'

Response

A successful response consists of one link to the updated resource.

Create a customer contact response field	Create a customer contact response description
`location`	A link to the created resource including the UUID.

Update a customer contact

Update a new customer record.

Request

The customer UUID and contactUuid are required as path parameters.

Update a customer contact parameter name	Update a customer contact parameter format	Update a customer contact parameter description
`UUID`	uuid	Customer UUID.
`contactUuid`	uuid	Customer contact UUID.

Supply these request parameters to update a customer contact record. Required parameters are in bold.

Update a customer contact parameter name	Update a customer contact parameter format	Update a customer contact parameter description
`UUID`	uuid	Customer UUID.
`contactUuid`	uuid	Customer contact UUID.
`name`	string	Contact name. Must be between 1 and 100 characters.
`email`	string	Contact email address. Must be between 1 and 100 characters.
`streetAddress1`	string	Contact street address 1. Must be between 1 and 100 characters.
`streetAddress2`	string	Street address 2. Must be between 1 and 100 characters.
`city`	string	Contact city. Must be between 1 and 100 characters.
`mainDivision`	string	Contact main division. Must be between 1 and 100 characters.
`postalCode`	string	Contact postal code. Must be between 1 and 100 characters.
`country`	string	Contact country. Must be between 1 and 100 characters.
`phone`	string	Contact phone number. Can include up to 20 characters, with optional country code. This parameter supports separators including space, dash, dot, and parentheses. Extensions are not allowed.
`phoneExtension`	string	Contact phone extension. Can include up to 10 digits, numbers only.
`fax`	string	Contact fax number. Can include up to 20 characters, with optional country code. This parameter supports separators including space, dash, dot, and parentheses. An extension is optional and must start with `x` followed by 1 to 4 digits.
`department`	string	Contact department. Must be between 1 and 100 characters.
`emailSubscribedInd`	Boolean	Indicates whether the email address is subscribed to receive correspondence from Vertex (`true`) or not (`false`).
`primaryInd`	Boolean	Indicates whether this is the primary contact (`true`) or not (`false`).

Example request

curl --request POST \
  --url https://vertex-enterprise-group.readme.io/certificate-center/v1/customer/{customerUuid}/contact \
  --header 'content-type: application/json' \
  --header 'Authorization: Bearer <token>'  
  --data '{
    "name": "Contact2",
    "email": "[email protected]",
    "phoneExtension": "102",
    "emailSubscribedInd": false,
    "primaryInd": false
  }'

Response

A successful response consists of one link to the created resource.

Update a customer contact response field	Update a customer contact response description
`location`	A link to the updated resource including the UUID.

Delete a customer contact

Delete a contact associated with a specified customer.

Request

Supply a customer UUID and a customer contact UUID to delete the customer contact record.

Delete a customer contact request parameter name	Delete a customer contact request parameter format	Delete a customer contact request parameter description
`UUID`	uuid	Customer UUID.
`contactUuid`	uuid	Customer contact UUID.

Example request

curl --request DELETE \
     --url https://vertex-enterprise-group.readme.io/certificate-center/v1/customer/uuid/contact/contactUuid \
     --header 'accept: application/json'

Response

A successful response returns a 200 OK success message.