Updates: Check the release notes for new features and product updates.

REST Resource: partners

Stay organized with collections Save and categorize content based on your preferences.

Resource: Partner

Partner that is onboarded with a supported product.

JSON representation
{
  "name": string,
  "displayName": string,
  "productCapabilities": [
    {
      object (ProductCapability)
    }
  ],
  "company": string,
  "contactEmails": [
    string
  ],
  "dialogflowServiceAccountEmail": string
}
Fields
name

string

Immutable. The unique identifier of the partner.

Defined by the platform.

displayName

string

Required. The display name of the partner.

productCapabilities[]

object (ProductCapability)

The product capabilities of the partner.

company

string

Optional. The company name of the partner.

contactEmails[]

string

Optional. The list of contact emails.

dialogflowServiceAccountEmail

string

Output only. Service account with access to the Dialogflow Client API role. This account is created by the platform and provides access to Dialogflow.

ProductCapability

The product capabilities that the partner supports.

JSON representation
{
  "product": enum (Product),

  // Union field capabilities can be only one of the following:
  "businessMessagesCapability": {
    object (BusinessMessagesCapability)
  },
  "verifiedSmsCapability": {
    object (VerifiedSmsCapability)
  }
  // End of list of possible types for union field capabilities.
}
Fields
product

enum (Product)

The product supported by the partner.

Union field capabilities. Capabilities for the partner. capabilities can be only one of the following:
businessMessagesCapability

object (BusinessMessagesCapability)

Business Messages capability.

verifiedSmsCapability

object (VerifiedSmsCapability)

Verified SMS capability.

Product

The products supported by Business Communications.

Enums
PRODUCT_UNSPECIFIED Unspecified product.
BUSINESS_MESSAGES Business Messages product.
VERIFIED_SMS Verified SMS product.

BusinessMessagesCapability

Business Messages capabilities

JSON representation
{
  "webhookUrl": string
}
Fields
webhookUrl

string

Required. The webhook URL where the messages are delivered.

VerifiedSmsCapability

Verified SMS capabilities

JSON representation
{
  "webhookUrl": string
}
Fields
webhookUrl

string

Required. The webhook URL where the Verified SMS callbacks are delivered.

Methods

get

Get the information about the partner.

patch

Updates the information for a partner.