# Sunshine Conversations API API

> Sunshine Conversations API API on Apizie: 68 endpoints (List Apps, Create App, Get App, Update App, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/business:zendesk/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:zendesk`
- Category: Business
- Status: byok
- Source: https://zendesk.com
- Page: https://apizie.tech/api/business/zendesk
- OpenAPI: https://apizie.tech/api/business/zendesk/openapi.json

# Introduction Note: The documentation below applies to v2 of the API. For users wanting to access v1, please proceed here instead. Welcome to the Sunshine Conversations API. The API allows you to craft entirely unique…

## Endpoints

### List Apps
`GET https://apizie.tech/v1/business:zendesk/list-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| page | object | no | Contains parameters for applying cursor pagination. |
| filter | object | no | Contains parameters for filtering the results. |

### Create App
`POST https://apizie.tech/v1/business:zendesk/create-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| body | object | yes | JSON request body |

### Get App
`GET https://apizie.tech/v1/business:zendesk/get-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |

### Update App
`POST https://apizie.tech/v1/business:zendesk/update-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| body | object | yes | JSON request body |

### Delete App
`POST https://apizie.tech/v1/business:zendesk/delete-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |

### List App Keys
`GET https://apizie.tech/v1/business:zendesk/list-app-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |

### Create App Key
`POST https://apizie.tech/v1/business:zendesk/create-app-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| body | object | yes | JSON request body |

### Get App Key
`GET https://apizie.tech/v1/business:zendesk/get-app-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| keyId | string | yes | The id of the key. |

### Delete App Key
`POST https://apizie.tech/v1/business:zendesk/delete-app-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| keyId | string | yes | The id of the key. |

### Upload Attachment
`POST https://apizie.tech/v1/business:zendesk/upload-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| access | string | yes | The access level for the attachment. Currently the only available access level is public. Private is not supported. |
| for | string | no | Specifies the intended container for the attachment, to enable automatic attachment deletion (on deletion of associated message,… |
| conversationId | string | no | Links the attachment getting uploaded to the conversation ID. |
| body | object | yes | Form fields as a JSON object |

### Delete Attachment
`POST https://apizie.tech/v1/business:zendesk/delete-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| body | object | yes | JSON request body |

### List Conversations
`GET https://apizie.tech/v1/business:zendesk/list-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| page | object | no | Contains parameters for applying cursor pagination. |
| filter | object | yes | Contains parameters for filtering the results. |

### Create Conversation
`POST https://apizie.tech/v1/business:zendesk/create-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| body | object | yes | JSON request body |

### Get Conversation
`GET https://apizie.tech/v1/business:zendesk/get-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |

### Update Conversation
`POST https://apizie.tech/v1/business:zendesk/update-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | yes | JSON request body |

### Delete Conversation
`POST https://apizie.tech/v1/business:zendesk/delete-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |

### Join Conversation
`POST https://apizie.tech/v1/business:zendesk/join-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | yes | JSON request body |

### List Participants
`GET https://apizie.tech/v1/business:zendesk/list-participants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| page | object | no | Contains parameters for applying cursor pagination. |

### Leave Conversation
`POST https://apizie.tech/v1/business:zendesk/leave-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | yes | JSON request body |

### List Messages
`GET https://apizie.tech/v1/business:zendesk/list-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| page | object | no | Contains parameters for applying cursor pagination. |

### Post Message
`POST https://apizie.tech/v1/business:zendesk/post-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | yes | JSON request body |

### Delete All Messages
`POST https://apizie.tech/v1/business:zendesk/delete-all-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |

### Delete Message
`POST https://apizie.tech/v1/business:zendesk/delete-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| messageId | string | yes | The id of the message. |

### Post Activity
`POST https://apizie.tech/v1/business:zendesk/post-activity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | yes | JSON request body |

### Pass Control
`POST https://apizie.tech/v1/business:zendesk/pass-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | yes | JSON request body |

### Release Control
`POST https://apizie.tech/v1/business:zendesk/release-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | no | JSON request body |

### Offer Control
`POST https://apizie.tech/v1/business:zendesk/offer-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | yes | JSON request body |

### Accept Control
`POST https://apizie.tech/v1/business:zendesk/accept-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | yes | JSON request body |

### Download Message Ref
`POST https://apizie.tech/v1/business:zendesk/download-message-ref` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | yes | JSON request body |

### Post Conversion Events
`POST https://apizie.tech/v1/business:zendesk/post-conversion-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| conversationId | string | yes | Identifies the conversation. |
| body | object | yes | JSON request body |

### List Integrations
`GET https://apizie.tech/v1/business:zendesk/list-integrations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| page | object | no | Contains parameters for applying cursor pagination. |
| filter | object | no | Contains parameters for filtering the results. |

### Create Integration
`POST https://apizie.tech/v1/business:zendesk/create-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| body | object | yes | JSON request body |

### Get Integration
`GET https://apizie.tech/v1/business:zendesk/get-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |

### Update Integration
`POST https://apizie.tech/v1/business:zendesk/update-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |
| body | object | yes | JSON request body |

### Delete Integration
`POST https://apizie.tech/v1/business:zendesk/delete-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |

### List Integration Keys
`GET https://apizie.tech/v1/business:zendesk/list-custom-integration-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |

### Create Integration Key
`POST https://apizie.tech/v1/business:zendesk/create-custom-integration-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |
| body | object | yes | JSON request body |

### Get Integration Key
`GET https://apizie.tech/v1/business:zendesk/get-custom-integration-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |
| keyId | string | yes | The id of the key. |

### Delete Integration Key
`POST https://apizie.tech/v1/business:zendesk/delete-custom-integration-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |
| keyId | string | yes | The id of the key. |

### List Webhooks
`GET https://apizie.tech/v1/business:zendesk/list-webhooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |

### Create Webhook
`POST https://apizie.tech/v1/business:zendesk/create-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |
| body | object | yes | JSON request body |

### Get Webhook
`GET https://apizie.tech/v1/business:zendesk/get-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |
| webhookId | string | yes | The id of the webhook. |

### Update Webhook
`POST https://apizie.tech/v1/business:zendesk/update-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |
| webhookId | string | yes | The id of the webhook. |
| body | object | yes | JSON request body |

### Delete Webhook
`POST https://apizie.tech/v1/business:zendesk/delete-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| integrationId | string | yes | The id of the integration. |
| webhookId | string | yes | The id of the webhook. |

### List Switchboards
`GET https://apizie.tech/v1/business:zendesk/list-switchboards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |

### Create Switchboard
`POST https://apizie.tech/v1/business:zendesk/create-switchboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |

### Update Switchboard
`POST https://apizie.tech/v1/business:zendesk/update-switchboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| switchboardId | string | yes | Identifies the switchboard. |
| body | object | yes | JSON request body |

### Delete Switchboard
`POST https://apizie.tech/v1/business:zendesk/delete-switchboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| switchboardId | string | yes | Identifies the switchboard. |

### List Switchboard Integrations
`GET https://apizie.tech/v1/business:zendesk/list-switchboard-integrations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| switchboardId | string | yes | Identifies the switchboard. |

### Create Switchboard Integration
`POST https://apizie.tech/v1/business:zendesk/create-switchboard-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| switchboardId | string | yes | Identifies the switchboard. |
| body | object | yes | JSON request body |

### Update Switchboard Integration
`POST https://apizie.tech/v1/business:zendesk/update-switchboard-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| switchboardId | string | yes | Identifies the switchboard. |
| switchboardIntegrationId | string | yes | Identifies the switchboard integration. |
| body | object | yes | JSON request body |

### Delete Switchboard Integration
`POST https://apizie.tech/v1/business:zendesk/delete-switchboard-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| switchboardId | string | yes | Identifies the switchboard. |
| switchboardIntegrationId | string | yes | Identifies the switchboard integration. |

### List Users
`GET https://apizie.tech/v1/business:zendesk/list-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| filter | object | yes | Contains parameters for filtering the results. |
| brandId | string | no | Identifies the brand. Provide this when querying a brand-separated user by externalId or identity. |

### Create User
`POST https://apizie.tech/v1/business:zendesk/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| body | object | yes | JSON request body |

### Get User
`GET https://apizie.tech/v1/business:zendesk/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| userIdOrExternalId | string | yes | The user's id or externalId. |
| brandId | string | no | Identifies the brand. Provide this when querying a brand-separated user by externalId or identity. |

### Update User
`POST https://apizie.tech/v1/business:zendesk/update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| userIdOrExternalId | string | yes | The user's id or externalId. |
| brandId | string | no | Identifies the brand. Provide this when querying a brand-separated user by externalId or identity. |
| body | object | yes | JSON request body |

### Delete User
`POST https://apizie.tech/v1/business:zendesk/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| userIdOrExternalId | string | yes | The user's id or externalId. |
| brandId | string | no | Identifies the brand. Provide this when querying a brand-separated user by externalId or identity. |

### List Clients
`GET https://apizie.tech/v1/business:zendesk/list-clients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| userIdOrExternalId | string | yes | The user's id or externalId. |
| brandId | string | no | Identifies the brand. Provide this when querying a brand-separated user by externalId or identity. |
| page | object | no | Contains parameters for applying cursor pagination. |

### Create Client
`POST https://apizie.tech/v1/business:zendesk/create-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| userIdOrExternalId | string | yes | The user's id or externalId. |
| brandId | string | no | Identifies the brand. Provide this when querying a brand-separated user by externalId or identity. |
| body | object | yes | JSON request body |

### Remove Client
`POST https://apizie.tech/v1/business:zendesk/remove-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| userIdOrExternalId | string | yes | The user's id or externalId. |
| clientId | string | yes | The client's id. |
| brandId | string | no | Identifies the brand. Provide this when querying a brand-separated user by externalId or identity. |

### List Devices
`GET https://apizie.tech/v1/business:zendesk/list-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| userIdOrExternalId | string | yes | The user's id or externalId. |
| brandId | string | no | Identifies the brand. Provide this when querying a brand-separated user by externalId or identity. |

### Get Device
`GET https://apizie.tech/v1/business:zendesk/get-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| userIdOrExternalId | string | yes | The user's id or externalId. |
| deviceId | string | yes | The device's id. |
| brandId | string | no | Identifies the brand. Provide this when querying a brand-separated user by externalId or identity. |

### Delete User Personal Information
`POST https://apizie.tech/v1/business:zendesk/delete-user-personal-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| userIdOrExternalId | string | yes | The user's id or externalId. |
| brandId | string | no | Identifies the brand. Provide this when querying a brand-separated user by externalId or identity. |

### Synchronize User
`POST https://apizie.tech/v1/business:zendesk/sync-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| appId | string | yes | Identifies the app. |
| zendeskId | string | yes | The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk… |
| body | object | no | JSON request body |

### Get Token Info
`GET https://apizie.tech/v1/business:zendesk/get-token-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |

### Authorize
`GET https://apizie.tech/v1/business:zendesk/authorize` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| client_id | string | yes | Your integration’s unique identifier |
| response_type | string | yes | For now the only acceptable value is code. |
| state | string | no | You may pass in any arbitrary string value here which will be returned to you along with the code via browser redirect. |
| redirect_uri | string | no | You may pass in a redirect_uri to determine which URI the response is redirected to. This URI must be contained in the list configured by… |

### Get Token
`POST https://apizie.tech/v1/business:zendesk/get-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |
| body | object | yes | JSON request body |

### Revoke Access
`POST https://apizie.tech/v1/business:zendesk/revoke-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subdomain | string | yes | Part of the server address: https://{subdomain}.zendesk.com/sc |

## Example
```
curl "https://apizie.tech/v1/business:zendesk/list-apps" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Sunshine Conversations API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/business:zendesk/list-apps with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Sunshine Conversations API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Sunshine Conversations API itself also needs your own key from zendesk.com.

### Can AI agents use the Sunshine Conversations API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:zendesk.

### What is the status of the Sunshine Conversations API API?
Needs your own provider key (bring your own key)