generated: '2026-07-21'
method: searched
source: https://developer.servicechannel.com/
docs: https://developer.servicechannel.com/basics/general/response-codes/
summary: >-
  Cross-cutting request/response conventions for the ServiceChannel Service
  Automation API (v3), derived from the OpenAPI and the developer docs.
authentication:
  style: oauth2
  flow: authorizationCode
  detail: authentication/servicechannel-authentication.yml
idempotency:
  supported: false
  note: >-
    No Idempotency-Key header or idempotent-retry contract is documented or
    present in the OpenAPI. Retries of non-GET operations are not guaranteed
    safe.
pagination:
  style: page-number
  params:
    - name: page
      in: query
      description: 1-based page number.
    - name: pageSize
      in: query
      description: Number of records per page.
  note: >-
    Error code 922 is returned for an invalid paging parameter.
versioning:
  scheme: uri-path
  current: v3
  detail: lifecycle/servicechannel-lifecycle.yml
rate_limiting:
  signal: http-status
  status: 429
  retry_header: Retry-After
  note: >-
    Reaching call limits returns HTTP 429 (since 2019; previously 503). Clients
    should honor the Retry-After header before retrying.
error_envelope:
  description: ServiceChannel.Services.Messaging.ErrorResponse
  fields:
    ErrorCodes: array of integer internal error codes
    ErrorCode: integer first error code encountered
    ErrorMessage: string human-readable description
  detail: errors/servicechannel-error-codes.yml
webhooks:
  supported: true
  detail: asyncapi/servicechannel-webhooks.yml
formats:
  request: application/json
  response: application/json
  legacy: >-
    Some integration endpoints (OutgoingXml tag) exchange XML (cXML) for
    notifications.