Partner Management

Endpoints for managing partner accounts and settings

Retrieve partner

get

Use this endpoint to get partner account info.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

Responses

200

Successful response

application/json

idstringOptional

Partner ID

Example: examplePA

brand_namestringOptional

Brand name

Example: 360dialog

payment_requiredbooleanOptionalDeprecated

[Deprecated]

Example: true

logo_urlstring · nullableOptional

Logo url

Example: https://storage.com/logo.png

onboarding_deeplink_add_paramsbooleanOptionalDeprecated

[Internal Field]

webhook_urlstring · urlOptional

Webhook url for Partners API events (non-messaging)

Example: https://yourwebsite.com/webhook

partner_redirect_urlstring · urlOptional

Partner redirect URL, clients will be redirected to this URL after integrated onboarding is done.

Example: https://yourwebsite.com/redirect

countrystringOptional

Country code

Example: US

blocked_new_submissionbooleanOptionalDeprecated

[Internal Field]

allow_client_to_add_phone_nobooleanOptional

If set to false, clients will not be able to onboard new numbers

Example: true

settingsany ofOptional

Settings that configure features of the partner hub

or

object · nullableOptional

billing_systemstringOptionalDeprecated

[Internal Field]

publishable_keystring · nullableOptionalDeprecated

[Deprecated] Stripe public key

Default: null

400

Wrong payload

application/json

404

Not found

application/json

get

/api/v2/partners/{partner_id}

HTTPcURLJavaScriptPython

GET /api/v2/partners/{partner_id} HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "examplePA",
  "brand_name": "360dialog",
  "logo_url": "https://storage.com/logo.png",
  "webhook_url": "https://yourwebsite.com/webhook",
  "partner_redirect_url": "https://yourwebsite.com/redirect",
  "country": "US",
  "allow_client_to_add_phone_no": true,
  "settings": {
    "partner_change_request": {
      "auto_approve": true
    },
    "account_sharing": {
      "solution_id": "1343564534452435",
      "business_manager_id": "24862834653473623",
      "solution_status": "ACTIVE"
    },
    "default_data_localization_region": "DE",
    "use_marketing_messages_api": true,
    "bearer_token_auth_disabled": false,
    "io_secure": {
      "io_secret": "9i3fKnYx...",
      "io_signature_verification_enabled": false
    }
  }
}

Update partner

patch

Use this endpoint to update some partner account settings like webhook_url and partner_redirect_url.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

Body

application/json

webhook_urlstringOptional

Webhook URL

Example: https://company.com/webhook

partner_redirect_urlstringOptional

Partner redirect URL, clients will be redirected to this URL after integrated onboarding is done.

Example: https://company.com/onboarding-redirect

allow_client_to_add_phone_nobooleanOptional

Allow clients to add phone numbers?

Example: true

Responses

200

Successful response

application/json

idstringOptional

Partner ID

Example: examplePA

brand_namestringOptional

Brand name

Example: 360dialog

payment_requiredbooleanOptionalDeprecated

[Deprecated]

Example: true

logo_urlstring · nullableOptional

Logo url

Example: https://storage.com/logo.png

onboarding_deeplink_add_paramsbooleanOptionalDeprecated

[Internal Field]

webhook_urlstring · urlOptional

Webhook url for Partners API events (non-messaging)

Example: https://yourwebsite.com/webhook

partner_redirect_urlstring · urlOptional

Partner redirect URL, clients will be redirected to this URL after integrated onboarding is done.

Example: https://yourwebsite.com/redirect

countrystringOptional

Country code

Example: US

blocked_new_submissionbooleanOptionalDeprecated

[Internal Field]

allow_client_to_add_phone_nobooleanOptional

If set to false, clients will not be able to onboard new numbers

Example: true

settingsany ofOptional

Settings that configure features of the partner hub

or

object · nullableOptional

billing_systemstringOptionalDeprecated

[Internal Field]

publishable_keystring · nullableOptionalDeprecated

[Deprecated] Stripe public key

Default: null

400

Wrong payload

application/json

404

Not found

application/json

patch

/api/v2/partners/{partner_id}

HTTPcURLJavaScriptPython

PATCH /api/v2/partners/{partner_id} HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "webhook_url": "https://company.com/webhook",
  "partner_redirect_url": "https://company.com/onboarding-redirect",
  "allow_client_to_add_phone_no": true
}

{
  "id": "examplePA",
  "brand_name": "360dialog",
  "logo_url": "https://storage.com/logo.png",
  "webhook_url": "https://yourwebsite.com/webhook",
  "partner_redirect_url": "https://yourwebsite.com/redirect",
  "country": "US",
  "allow_client_to_add_phone_no": true,
  "settings": {
    "partner_change_request": {
      "auto_approve": true
    },
    "account_sharing": {
      "solution_id": "1343564534452435",
      "business_manager_id": "24862834653473623",
      "solution_status": "ACTIVE"
    },
    "default_data_localization_region": "DE",
    "use_marketing_messages_api": true,
    "bearer_token_auth_disabled": false,
    "io_secure": {
      "io_secret": "9i3fKnYx...",
      "io_signature_verification_enabled": false
    }
  }
}