Create Partner Integration

Create a partner integration with a business.

Parameters
  • dataformData, objectRequired

    Form Data needed when creating a new Partner Integrations.

    • typestringRequired

      Provide Partner Integrations type. Current selection is only partner_integrations.

    • attributesformData, objectRequired

      Attributes object.

      • integration_loginstringRequired

        Integration credentials - login.

      • integration_passwordintegerRequired

        Integration credentials - password.

    • relationshipsformData, objectRequired

      Relationships object with business object.

      • businessformData, objectRequired

        Add a Business relationships link.

        • idstringRequired

          Related Business id.

        • typestringRequired

          Business type; business.

      • partnerformData, objectRequired

        Add a Partner relationships link.

        • idstringRequired

          Related Partner id.

        • typestringRequired

          Partner type; partner.

POST/api/v1/partner_integrations/connect

{
  const res = await fetch(`${BASE_URL}/api/v1/partner_integrations/connect`, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)});

  const data = await res.json();
}

RESPONSE


Delete Partner Integration

Delete a partner integration with a business.

Parameters
  • dataformData, objectRequired

    Form Data needed when deleting a Partner Integrations.

    • typestringRequired

      Provide Partner Integrations type. Current selection is only partner_integrations.

    • relationshipsformData, objectRequired

      Relationships object with business object.

      • businessformData, objectRequired

        Add a Business relationships link.

        • idstringRequired

          Related Business id.

        • typestringRequired

          Business type; business.

      • partnerformData, objectRequired

        Add a Partner relationships link.

        • idstringRequired

          Related Partner id.

        • typestringRequired

          Partner type; partner.

DELETE/api/v1/partner_integrations/disconnect

{
  const res = await fetch(`${BASE_URL}/api/v1/partner_integrations/disconnect`, {
    method: 'DELETE',
    headers: {
      'Content-Type': 'application/json'
    }});
  const data = await res.json();
}