Sunshine Conversations API

Sunshine Conversations API

API version: 17.8.0

Auth

Bearer bearer | Bearer basic

Base URL

https://{subdomain}.zendesk.com/sc

Setup

1. Set Authorization header with your Bearer token
2. GET /v2/apps -- verify access
3. POST /v2/apps -- create first apps

Endpoints

68 endpoints across 3 groups. See references/api-spec.lap for full details.

apps

tokenInfo

oauth

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a app?" -> POST /v2/apps
• "List all apps?" -> GET /v2/apps
• "Get app details?" -> GET /v2/apps/{appId}
• "Partially update a app?" -> PATCH /v2/apps/{appId}
• "Delete a app?" -> DELETE /v2/apps/{appId}
• "Create a key?" -> POST /v2/apps/{appId}/keys
• "List all keys?" -> GET /v2/apps/{appId}/keys
• "Get key details?" -> GET /v2/apps/{appId}/keys/{keyId}
• "Delete a key?" -> DELETE /v2/apps/{appId}/keys/{keyId}
• "Create a attachment?" -> POST /v2/apps/{appId}/attachments
• "Create a remove?" -> POST /v2/apps/{appId}/attachments/remove
• "Create a conversation?" -> POST /v2/apps/{appId}/conversations
• "List all conversations?" -> GET /v2/apps/{appId}/conversations
• "Get conversation details?" -> GET /v2/apps/{appId}/conversations/{conversationId}
• "Partially update a conversation?" -> PATCH /v2/apps/{appId}/conversations/{conversationId}
• "Delete a conversation?" -> DELETE /v2/apps/{appId}/conversations/{conversationId}
• "Create a join?" -> POST /v2/apps/{appId}/conversations/{conversationId}/join
• "List all participants?" -> GET /v2/apps/{appId}/conversations/{conversationId}/participants
• "Create a leave?" -> POST /v2/apps/{appId}/conversations/{conversationId}/leave
• "Create a message?" -> POST /v2/apps/{appId}/conversations/{conversationId}/messages
• "List all messages?" -> GET /v2/apps/{appId}/conversations/{conversationId}/messages
• "Delete a message?" -> DELETE /v2/apps/{appId}/conversations/{conversationId}/messages/{messageId}
• "Create a activity?" -> POST /v2/apps/{appId}/conversations/{conversationId}/activity
• "Create a acceptControl?" -> POST /v2/apps/{appId}/conversations/{conversationId}/acceptControl
• "Create a offerControl?" -> POST /v2/apps/{appId}/conversations/{conversationId}/offerControl
• "Create a passControl?" -> POST /v2/apps/{appId}/conversations/{conversationId}/passControl
• "Create a releaseControl?" -> POST /v2/apps/{appId}/conversations/{conversationId}/releaseControl
• "Create a download?" -> POST /v2/apps/{appId}/conversations/{conversationId}/download
• "Create a conversionEvent?" -> POST /v2/apps/{appId}/conversations/{conversationId}/conversionEvents
• "Create a integration?" -> POST /v2/apps/{appId}/integrations
• "List all integrations?" -> GET /v2/apps/{appId}/integrations
• "Get integration details?" -> GET /v2/apps/{appId}/integrations/{integrationId}
• "Partially update a integration?" -> PATCH /v2/apps/{appId}/integrations/{integrationId}
• "Delete a integration?" -> DELETE /v2/apps/{appId}/integrations/{integrationId}
• "Create a key?" -> POST /v2/apps/{appId}/integrations/{integrationId}/keys
• "List all keys?" -> GET /v2/apps/{appId}/integrations/{integrationId}/keys
• "Get key details?" -> GET /v2/apps/{appId}/integrations/{integrationId}/keys/{keyId}
• "Delete a key?" -> DELETE /v2/apps/{appId}/integrations/{integrationId}/keys/{keyId}
• "Create a webhook?" -> POST /v2/apps/{appId}/integrations/{integrationId}/webhooks
• "List all webhooks?" -> GET /v2/apps/{appId}/integrations/{integrationId}/webhooks
• "Get webhook details?" -> GET /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId}
• "Partially update a webhook?" -> PATCH /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId}
• "Delete a webhook?" -> DELETE /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId}
• "Create a switchboard?" -> POST /v2/apps/{appId}/switchboards
• "List all switchboards?" -> GET /v2/apps/{appId}/switchboards
• "Partially update a switchboard?" -> PATCH /v2/apps/{appId}/switchboards/{switchboardId}
• "Delete a switchboard?" -> DELETE /v2/apps/{appId}/switchboards/{switchboardId}
• "Create a switchboardIntegration?" -> POST /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations
• "List all switchboardIntegrations?" -> GET /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations
• "Partially update a switchboardIntegration?" -> PATCH /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations/{switchboardIntegrationId}
• "Delete a switchboardIntegration?" -> DELETE /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations/{switchboardIntegrationId}
• "Create a user?" -> POST /v2/apps/{appId}/users
• "List all users?" -> GET /v2/apps/{appId}/users
• "Get user details?" -> GET /v2/apps/{appId}/users/{userIdOrExternalId}
• "Partially update a user?" -> PATCH /v2/apps/{appId}/users/{userIdOrExternalId}
• "Delete a user?" -> DELETE /v2/apps/{appId}/users/{userIdOrExternalId}
• "Create a client?" -> POST /v2/apps/{appId}/users/{userIdOrExternalId}/clients
• "List all clients?" -> GET /v2/apps/{appId}/users/{userIdOrExternalId}/clients
• "Delete a client?" -> DELETE /v2/apps/{appId}/users/{userIdOrExternalId}/clients/{clientId}
• "List all devices?" -> GET /v2/apps/{appId}/users/{userIdOrExternalId}/devices
• "Get device details?" -> GET /v2/apps/{appId}/users/{userIdOrExternalId}/devices/{deviceId}
• "Create a sync?" -> POST /v2/apps/{appId}/users/{zendeskId}/sync
• "List all tokenInfo?" -> GET /v2/tokenInfo
• "List all authorize?" -> GET /oauth/authorize
• "Create a token?" -> POST /oauth/token
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP