CHcheckhq

Authorize an Integration Partner

put/integrations/partners/{integration_partner}/authorize

Request

Path parameters

integration_partnerstring required

ID of the Integration Partner

Request body

companystring required

ID of the company whose data you want to grant the Integration Partner access to

integration_permissionstring required

ID of the Integration Permission you want to grant to the Integration Partner

tos_timestampstring required

The timestamp when the customer consented to a terms of service document consenting to sharing their data with the Integration Partner. Must be an ISO 8601 date-time string, e.g. 2026-07-16T14:30:00Z. Always include a timezone designator (Z or a UTC offset like -05:00); a value without one is interpreted in the server's default timezone.

product_purchase_timestampstring required

The timestamp when the customer purchased the product offered by the Integration Partner. Must be an ISO 8601 date-time string, e.g. 2026-07-16T14:30:00Z. Always include a timezone designator (Z or a UTC offset like -05:00); a value without one is interpreted in the server's default timezone.

Response

200

idstring
companystring
statusstring
integration_permissionstring
access_typestring
integration_partnerstring
scopestring[]

Example response

{
  "id": "<integration access id>",
  "company": "com_vQHrDCeILCSuI6hkAPpV",
  "status": "pending",
  "integration_permission": "ipe_08auhI2IUXcdtFTtOm7c",
  "access_type": "test",
  "integration_partner": "int_Xf90bJAKE9Lf2jVjbgne",
  "scope": [
    "company:read"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.