Flipdish

Flipdish SmsProviderCredentials API

Operations for Sms Provider Credentials.

Documentation GitHub OpenAPI

Operations 5

GET /api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials Get brand sms provider credentials #

GET /api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType} Get brand sms provider credential by service type #

POST /api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType} Sms provider credential update #

DELETE /api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType} Sms provider credential delete #

POST /api/v1.0/sms-providers/bulk-upsert Sms provider credentials bulk upsert #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/flipdish/openapi/flipdish-smsprovidercredentials-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/flipdish:flipdish-smsprovidercredentials-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Flipdish Sms Provider Credentials API
  version: v1.0
  x-refined-note:
  - x-generated-from differs across the merged source definitions and was not carried
  - x-last-validated differs across the merged source definitions and was not carried
  description: 'Operations tagged SmsProviderCredentials across 2 of this provider''s published API definitions: flipdish-openapi.json, flipdish-platform-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.flipdish.co
tags:
- name: SmsProviderCredentials
paths:
  /api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials:
    get:
      tags:
      - SmsProviderCredentials
      operationId: GetBrandSmsProviderCredentials
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: brandId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiArrayResult_SmsProviderCredential'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiArrayResult_SmsProviderCredential'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiArrayResult_SmsProviderCredential'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiArrayResult_SmsProviderCredential'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      summary: Get brand sms provider credentials
      x-summary-source: derived
    servers:
    - url: https://api.flipdish.co
  /api/v1.0/sms-providers/orgs/{orgId}/brands/{brandId}/provider-credentials/{serviceType}:
    get:
      tags:
      - SmsProviderCredentials
      operationId: GetBrandSmsProviderCredentialByServiceType
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: brandId
        in: path
        required: true
        schema:
          type: string
      - name: serviceType
        in: path
        required: true
        schema:
          type: string
          enum:
          - Nexmo
          - Twilio
          - Default
          - MessageBird
          - CommunicationService
      - name: withFallback
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      summary: Get brand sms provider credential by service type
      x-summary-source: derived
    post:
      tags:
      - SmsProviderCredentials
      operationId: SmsProviderCredentialUpdate
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: brandId
        in: path
        required: true
        schema:
          type: string
      - name: serviceType
        in: path
        required: true
        schema:
          type: string
          enum:
          - Nexmo
          - Twilio
          - Default
          - MessageBird
          - CommunicationService
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmsProviderCredentialUpdateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/SmsProviderCredentialUpdateRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/SmsProviderCredentialUpdateRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/SmsProviderCredentialUpdateRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SmsProviderCredentialUpdateRequest'
        required: true
      summary: Sms provider credential update
      x-summary-source: derived
    delete:
      tags:
      - SmsProviderCredentials
      operationId: SmsProviderCredentialDelete
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: brandId
        in: path
        required: true
        schema:
          type: string
      - name: serviceType
        in: path
        required: true
        schema:
          type: string
          enum:
          - Nexmo
          - Twilio
          - Default
          - MessageBird
          - CommunicationService
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_SmsProviderCredential'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      summary: Sms provider credential delete
      x-summary-source: derived
    servers:
    - url: https://api.flipdish.co
  /api/v1.0/sms-providers/bulk-upsert:
    post:
      tags:
      - SmsProviderCredentials
      operationId: SmsProviderCredentialsBulkUpsert
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiArrayResult_SmsProviderCredential'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiArrayResult_SmsProviderCredential'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiArrayResult_SmsProviderCredential'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiArrayResult_SmsProviderCredential'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SmsProviderCredential'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SmsProviderCredential'
          application/xml:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SmsProviderCredential'
          text/xml:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SmsProviderCredential'
          application/x-www-form-urlencoded:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SmsProviderCredential'
        required: true
      summary: Sms provider credentials bulk upsert
      x-summary-source: derived
    servers:
    - url: https://api.flipdish.co
components:
  schemas:
    RestApiResult_SmsProviderCredential:
      description: Rest api result
      required:
      - Data
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/SmsProviderCredential'
          description: Generic data object.
    RestApiArrayResult_SmsProviderCredential:
      description: Rest api array result
      required:
      - Data
      type: object
      properties:
        Data:
          description: Generic data object.
          type: array
          items:
            $ref: '#/components/schemas/SmsProviderCredential'
    RestApiForbiddenResult:
      description: Rest Api Forbidden Result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Message
          type: string
          readOnly: true
    SmsProviderCredential:
      description: SmsProviderCredential.
      type: object
      properties:
        OrgId:
          description: OrgId.
          type: string
        BrandId:
          description: BrandId.
          type: string
        SmsServiceType:
          description: SmsServiceType.
          enum:
          - Nexmo
          - Twilio
          - Default
          - MessageBird
          - CommunicationService
          type: string
        SenderId:
          description: SenderId.
          type: string
        Username:
          description: Username.
          type: string
        AuthToken:
          description: AuthToken.
          type: string
    SmsProviderCredentialUpdateRequest:
      description: SmsProviderCredentialUpdateRequest.
      type: object
      properties:
        SenderId:
          description: SenderId.
          type: string
        Username:
          description: Username.
          type: string
        AuthToken:
          description: AuthToken.
          type: string
    RestApiUnauthorizedResult:
      description: Rest api unauthorized result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Message
          type: string
          readOnly: true
    ValidationErrorResult:
      description: Validation error result
      type: object
      properties:
        FieldName:
          description: Field name
          type: string
        Errors:
          description: List of errors relates to field
          type: array
          items:
            type: string
    RestApiErrorResult:
      description: Rest api error result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Error message
          type: string
        ErrorCode:
          format: int32
          description: Error code
          type: integer
        StackTrace:
          description: Stack trace
          type: string
        Errors:
          description: List of errors grouped by field name
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorResult'
    RestApiArrayResult_SmsProviderCredential_:
      description: Rest api array result
      required:
      - Data
      type: object
      properties:
        Data:
          description: Generic data object.
          type: array
          items:
            $ref: '#/components/schemas/SmsProviderCredential_2'
          example: []
    RestApiResult_SmsProviderCredential_:
      description: Rest api result
      required:
      - Data
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/SmsProviderCredential_2'
    SmsProviderCredential_2:
      description: SmsProviderCredential.
      type: object
      properties:
        OrgId:
          description: OrgId.
          type: string
          example: '500123'
        BrandId:
          description: BrandId.
          type: string
          example: '500123'
        SmsServiceType:
          description: SmsServiceType.
          enum:
          - Nexmo
          - Twilio
          - Default
          - MessageBird
          type: string
          example: Nexmo
        SenderId:
          description: SenderId.
          type: string
          example: '500123'
        Username:
          description: Username.
          type: string
          example: Example Name
        AuthToken:
          description: AuthToken.
          type: string
          example: string
    SmsProviderCredentialUpdateRequest_2:
      description: SmsProviderCredentialUpdateRequest.
      type: object
      properties:
        SenderId:
          description: SenderId.
          type: string
          example: '500123'
        Username:
          description: Username.
          type: string
          example: Example Name
        AuthToken:
          description: AuthToken.
          type: string
          example: string
    FlipdishError:
      type: object
      description: Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.flipdish.com/docs/error-handling).
      properties:
        error:
          type: object
          description: Error detail object.
          properties:
            errorMessage:
              type: string
              description: Descriptive explanation of the issue.
              example: Invalid or missing parameters.
            errorCode:
              type: string
              description: Unique identifier for programmatic error handling.
              example: BadRequest
            details:
              type: string
              description: Additional context returned in non-production environments.
              example: Validation failed for field 'storeId'.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            api: Access to Flipdish API
          authorizationUrl: https://api.flipdish.co/identity/connect/authorize
      description: OAuth2 Implicit Grant
x-refined-from:
- flipdish-openapi.json
- flipdish-platform-openapi.json