openapi: 3.2.0
info:
  title: api-specifications Customer API
  version: '1.1'
servers:
- url: https://{your-domain}.com
  variables:
    your-domain:
      default: your-domain
security:
- {}
tags:
- name: Customer
paths:
  /customer/bestmatch:
    post:
      summary: bestmatchCustomers
      description: Find a customer best match based on known Social Information
      operationId: bestmatchcustomers
      parameters:
      - name: x-sf-user-email
        in: header
        description: The email ID of the Khoros Marketing agent performing the action.
        schema:
          type: string
      - name: x-sf-initiative
        in: header
        description: The ID of the active Khoros Marketing initiative the user is in when performing the action.
        schema:
          type: integer
          format: int32
      - name: x-sf-company-id
        in: header
        description: The Khoros Marketing ID of the company the user is in when making the request.
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                displayName:
                  type: string
                  description: The name of the user as it would appear on the social network.
                screenName:
                  type: string
                  description: The social handle of the user.
                description:
                  type: string
                  description: A description of the user as specified in Khoros Marketing.
                profileUrl:
                  type: string
                  description: 'A direct link to the user''s social profile #header.'
                email:
                  type: string
                  description: An email address to the user.
                phoneNumbers:
                  type: array
                  description: A list of phone numbers for the user as defined in Khoros Marketing.
                  items:
                    type: string
                addresses:
                  type: array
                  description: A list of addresses for the user as defined in Khoros Marketing.
                  items:
                    properties:
                      streetOne:
                        type: string
                        description: First line of an address.
                      streetTwo:
                        type: string
                        description: Optional line two of an address.
                      city:
                        type: string
                        description: City of an address.
                      state:
                        type: string
                        description: State of an address.
                      zip:
                        type: string
                        description: Postal code of an address.
                    type: object
                orderNumbers:
                  type: array
                  description: A list of order numbers for the user as defined in Khoros Marketing.
                  items:
                    type: string
                caseNumbers:
                  type: array
                  description: A list of case numbers for the user as defined in Khoros Marketing. **Note:** These will not be case numbers from this system.
                  items:
                    type: string
                accountNumbers:
                  type: string
                  description: A list of account numbers for the user as defined in Khoros Marketing.
      responses:
        '200':
          description: '200'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '400':
          description: '400'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
      deprecated: false
      security: []
      tags:
      - Customer
  /customer:
    post:
      summary: createCustomer
      description: Create a new customer
      operationId: createcustomer
      parameters:
      - name: x-sf-user-email
        in: header
        description: The email id of the Khoros Marketing agent performing the action.
        schema:
          type: string
      - name: x-sf-initiative
        in: header
        description: The id of the active Khoros Marketing Initiative the user is in when performing the action.
        schema:
          type: string
      - name: x-sf-company-id
        in: header
        description: The Khoros Marketing id of the company the user is in when making the request.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customNonSearchableCustomerFieldOne:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": false`.'
                customNonSearchableCustomerFieldTwo:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": false`.'
                customSearchableCustomerFieldOne:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": true`.'
                customSearchableCustomerFieldTwo:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": true`.'
      responses:
        '201':
          description: '201'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"id\": 1234,\n  \"nonSearchableFieldOne\": \"value1\",\n  \"searchableFieldTwo\": \"value2\"\n}"
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1234
                    default: 0
                  nonSearchableFieldOne:
                    type: string
                    example: value1
                  searchableFieldTwo:
                    type: string
                    example: value2
        '400':
          description: '400'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '422':
          description: '422'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
      deprecated: false
      security: []
      tags:
      - Customer
  /customer/{id}:
    get:
      summary: findCustomer
      description: Returns info for a specific customer
      operationId: findcustomer
      parameters:
      - name: id
        in: path
        description: Customer ID
        schema:
          type: string
        required: true
      - name: x-sf-user-email
        in: header
        description: The email ID of the Khoros Marketing agent performing the action.
        schema:
          type: string
      - name: x-sf-initiative
        in: header
        description: The ID of the active Khoros Marketing initiative the user is in when performing the action. **Format:** int64
        schema:
          type: integer
          format: int32
      - name: x-sf-company-id
        in: header
        description: The Khoros Marketing ID of the company the user is in when making the request. **Format:** int64
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: '200'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: See Details for Schema
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '404':
          description: '404'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
      deprecated: false
      security: []
      tags:
      - Customer
    patch:
      summary: updateCustomer
      description: Update a customer’s details
      operationId: updatecustomer
      parameters:
      - name: x-sf-user-email
        in: header
        description: The email id of the Khoros Marketing agent performing the action.
        schema:
          type: string
      - name: x-sf-initiative
        in: header
        description: The id of the active Khoros Marketing Initiative the user is in when performing the action.
        schema:
          type: string
      - name: x-sf-company-id
        in: header
        description: The Khoros Marketing id of the company the user is in when making the request.
        schema:
          type: string
      - name: id
        in: path
        description: Customer ID
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customNonSearchableCustomerFieldOne:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": false`. These will only be present if specified via the [createCustomer](ref:createcustomer) endpoint.'
                customNonSearchableCustomerFieldTwo:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": false`. These will only be present if specified via the [createCustomer](ref:createcustomer) endpoint.'
                customSearchableCustomerFieldOne:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": true`. These will only be present if specified via the [createCustomer](ref:createcustomer) endpoint.'
                customSearchableCustomerFieldTwo:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": true`. These will only be present if specified via the [createCustomer](ref:createcustomer) endpoint.'
      responses:
        '201':
          description: '201'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '400':
          description: '400'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '422':
          description: '422'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
      deprecated: false
      security: []
      tags:
      - Customer
  /customer/{id}/cases:
    get:
      summary: findCases
      description: Get all cases for the given customer ID
      operationId: findcases
      parameters:
      - name: id
        in: path
        description: Customer ID
        schema:
          type: string
        required: true
      - name: x-sf-user-email
        in: header
        description: The email ID of the Khoros Marketing agent performing the action.
        schema:
          type: string
      - name: x-sf-initiative
        in: header
        description: The ID of the active Khoros Marketing initiative the user is in when performing the action. **Format:** int64
        schema:
          type: integer
          format: int32
      - name: x-sf-company-id
        in: header
        description: The Khoros Marketing ID of the company the user is in when making the request. **Format:** int64
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: '200'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '400':
          description: '400'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '404':
          description: '404'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
      deprecated: false
      security: []
      tags:
      - Customer
x-readme:
  headers: []
  explorer-enabled: false
  proxy-enabled: false
x-readme-fauxas: true