Amazon Connect Connect Templates API

The Connect Templates API from Amazon Connect — 4 operation(s) for connect templates.

GitHub OpenAPI

Operations 6

POST /domains/{domainId}/templates Create Template #
POST /domains/{domainId}/templates/{templateId} Get Template #
PUT /domains/{domainId}/templates/{templateId} Update Template #
DELETE /domains/{domainId}/templates/{templateId} Delete Template #
GET /templates/{TemplateId} Get Profile Object Type Template #
GET /templates List Profile Object Type Templates #

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/amazon-connect:amazon-connect-templates-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.

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

OpenAPI Specification

amazon-connect-templates-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Connect Service Templates API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://cases.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /domains/{domainId}/templates:
    post:
      operationId: CreateTemplate
      summary: Create Template
      description: 'Creates a template in the Cases domain. This template is used to define the case object model (that is,
        to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain,
        and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed
        within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates
        cannot be used to create cases. Other template APIs are: DeleteTemplate GetTemplate ListTemplates UpdateTemplate'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTemplateResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTemplateRequest'
      tags:
      - Templates
  /domains/{domainId}/templates/{templateId}:
    post:
      operationId: GetTemplate
      summary: Get Template
      description: 'Returns the details for the requested template. Other template APIs are: CreateTemplate DeleteTemplate
        ListTemplates UpdateTemplate'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTemplateResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTemplateRequest'
      tags:
      - Templates
    put:
      operationId: UpdateTemplate
      summary: Update Template
      description: 'Updates the attributes of an existing template. The template attributes that can be modified include name,
        description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If
        a null value is provided for a given attribute, that attribute is ignored and its current value is preserved. Other
        template APIs are: CreateTemplate DeleteTemplate GetTemplate ListTemplates'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTemplateResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTemplateRequest'
      tags:
      - Templates
    delete:
      operationId: DeleteTemplate
      summary: Delete Template
      description: 'Deletes a Cases template. You can delete up to 100 templates per domain. After a Cases template is deleted:
        You can still retrieve the template by calling GetTemplate. You cannot update the template. You cannot create a case
        by using the deleted template. Deleted templates are not included in the ListTemplates response.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteTemplateResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteTemplateRequest'
      tags:
      - Templates
  /templates/{TemplateId}:
    get:
      operationId: GetProfileObjectTypeTemplate
      summary: Get Profile Object Type Template
      description: Returns the template information for a specific object type. A template is a predefined ProfileObjectType,
        such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject
        API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProfileObjectTypeTemplateResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetProfileObjectTypeTemplateRequest'
      tags:
      - Templates
      servers:
      - url: https://profile.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_profile: []
  /templates:
    get:
      operationId: ListProfileObjectTypeTemplates
      summary: List Profile Object Type Templates
      description: Lists all of the template information for object types.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProfileObjectTypeTemplatesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListProfileObjectTypeTemplatesRequest'
      tags:
      - Templates
      servers:
      - url: https://profile.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_profile: []
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: cases
    sigv4_profile:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: profile
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    CasesAccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CasesConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CasesResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: Unique identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    CasesServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CasesThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateTemplateRequest:
      type: object
      properties:
        domainId:
          type: string
          description: The unique identifier of the Cases domain.
        name:
          type: string
          description: A name for the template. It must be unique per domain.
        description:
          type: string
          description: A brief description of the template.
        layoutConfiguration:
          $ref: '#/components/schemas/LayoutConfiguration'
        requiredFields:
          type: array
          items:
            $ref: '#/components/schemas/RequiredField'
          description: A list of fields that must contain a value for a case to be successfully created with this template.
            To require a Customer Profile when creating cases, include customer_id in this list. If customer_id is omitted,
            the Customer Profile field is optional and can be added, changed, or removed after case creation.
        status:
          type: string
          description: The status of the template.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/TemplateRule'
          description: A list of case rules (also known as case field conditions) on a template.
        tagPropagationConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/TagPropagationConfiguration'
          description: Defines tag propagation configuration for resources created within a domain. Tags specified here will
            be automatically applied to resources being created for the specified resource type.
      required:
      - domainId
      - name
    CreateTemplateResponse:
      type: object
      properties:
        templateId:
          type: string
          description: A unique identifier of a template.
        templateArn:
          type: string
          description: The Amazon Resource Name (ARN) of the newly created template.
      required:
      - templateId
      - templateArn
    DeleteTemplateRequest:
      type: object
      properties:
        domainId:
          type: string
          description: The unique identifier of the Cases domain.
        templateId:
          type: string
          description: A unique identifier of a template.
      required:
      - domainId
      - templateId
    DeleteTemplateResponse:
      type: object
      properties: {}
    GetProfileObjectTypeTemplateRequest:
      type: object
      properties:
        TemplateId:
          type: string
          description: A unique identifier for the object template.
      required:
      - TemplateId
    GetProfileObjectTypeTemplateResponse:
      type: object
      properties:
        TemplateId:
          type: string
          description: A unique identifier for the object template.
        SourceName:
          type: string
          description: The name of the source of the object template.
        SourceObject:
          type: string
          description: The source of the object template.
        DefaultMaxProfileObjectCount:
          type: integer
          description: The default maximum number of objects of this object type that can be stored per profile. This default
            applies when you don't set MaxProfileObjectCount on an object type created from this template. If this value isn't
            present, no default limit applies.
        DefaultMaxProfileObjectCountEffectiveAfter:
          type: string
          format: date-time
          description: The timestamp after which DefaultMaxProfileObjectCount takes effect. The default limit applies only
            to domains created after this time.
        StoreOnly:
          type: boolean
          description: Indicates whether the template is store-only. Objects of an object type created from a store-only template
            are ingested and stored, but the object type can't be used by calculated attributes or event triggers.
        AllowProfileCreation:
          type: boolean
          description: Indicates whether a profile should be created when data is received if one doesn’t exist for an object
            of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to
            fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is
            found, then the service creates a new standard profile.
        SourceLastUpdatedTimestampFormat:
          type: string
          description: The format of your sourceLastUpdatedTimestamp that was previously set up.
        Fields:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ObjectTypeField'
          description: A map of the name and ObjectType field.
        Keys:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ObjectTypeKey'
          description: A list of unique keys that can be used to map data to the profile.
    GetTemplateRequest:
      type: object
      properties:
        domainId:
          type: string
          description: The unique identifier of the Cases domain.
        templateId:
          type: string
          description: A unique identifier of a template.
      required:
      - domainId
      - templateId
    GetTemplateResponse:
      type: object
      properties:
        templateId:
          type: string
          description: A unique identifier of a template.
        templateArn:
          type: string
          description: The Amazon Resource Name (ARN) of the template.
        name:
          type: string
          description: The name of the template.
        description:
          type: string
          description: A brief description of the template.
        layoutConfiguration:
          $ref: '#/components/schemas/LayoutConfiguration'
        requiredFields:
          type: array
          items:
            $ref: '#/components/schemas/RequiredField'
          description: A list of fields that must contain a value for a case to be successfully created with this template.
        tags:
          type: object
          additionalProperties:
            type: string
          description: A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control
            access for this resource.
        status:
          type: string
          description: The status of the template.
        deleted:
          type: boolean
          description: Denotes whether or not the resource has been deleted.
        createdTime:
          type: string
          format: date-time
          description: Timestamp at which the resource was created.
        lastModifiedTime:
          type: string
          format: date-time
          description: Timestamp at which the resource was created or last modified.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/TemplateRule'
          description: A list of case rules (also known as case field conditions) on a template.
        tagPropagationConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/TagPropagationConfiguration'
          description: Defines tag propagation configuration for resources created within a domain. Tags specified here will
            be automatically applied to resources being created for the specified resource type.
      required:
      - templateId
      - templateArn
      - name
      - status
    InternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried.
      required:
      - message
    LayoutConfiguration:
      type: object
      properties:
        defaultLayout:
          type: string
          description: Unique identifier of a layout.
    ListProfileObjectTypeTemplateItem:
      type: object
      properties:
        TemplateId:
          type: string
          description: A unique identifier for the object template.
        SourceName:
          type: string
          description: The name of the source of the object template.
        SourceObject:
          type: string
          description: The source of the object template.
    ListProfileObjectTypeTemplatesRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The pagination token from the previous ListObjectTypeTemplates API call.
        MaxResults:
          type: integer
          description: The maximum number of objects returned per page.
    ListProfileObjectTypeTemplatesResponse:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/ListProfileObjectTypeTemplateItem'
          description: The list of ListProfileObjectType template instances.
        NextToken:
          type: string
          description: The pagination token from the previous ListObjectTypeTemplates API call.
    ObjectTypeField:
      type: object
      properties:
        Source:
          type: string
          description: 'A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType
            of a Zendesk user and “FirstName” is a field in that ObjectType.'
        Target:
          type: string
          description: 'The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
            Do not include sensitive or personally identifiable information (PII) in the target field name.'
        ContentType:
          type: string
          enum:
          - STRING
          - NUMBER
          - PHONE_NUMBER
          - EMAIL_ADDRESS
          - NAME
          description: The content type of the field. Used for determining equality when searching.
    ObjectTypeKey:
      type: object
      properties:
        StandardIdentifiers:
          type: array
          items:
            type: string
            enum:
            - PROFILE
            - ASSET
            - CASE
            - DEVICE
            - WEB_ANALYTICS
            - ORDER
            - COMMUNICATION_RECORD
            - AIR_PREFERENCE
            - HOTEL_PREFERENCE
            - AIR_BOOKING
            - AIR_SEGMENT
            - HOTEL_RESERVATION
            - HOTEL_STAY_REVENUE
            - LOYALTY
            - LOYALTY_TRANSACTION
            - LOYALTY_PROMOTION
            - UNIQUE
            - SECONDARY
            - LOOKUP_ONLY
            - NEW_ONLY
          description: 'The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but
            multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE,
            ASSET, CASE, or ORDER respectively. UNIQUE means that it can be used to uniquely identify an object. If a key
            a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched.
            A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile.
            A NEW_ONLY key is only used if the profile does '
        FieldNames:
          type: array
          items:
            type: string
          description: The reference for the key name of the fields map.
    ProfileInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ProfileResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    RequiredField:
      type: object
      properties:
        fieldId:
          type: string
          description: Unique identifier of a field.
      required:
      - fieldId
    TagPropagationConfiguration:
      type: object
      properties:
        resourceType:
          type: string
          description: Supported resource types for tag propagation. Determines which resources will receive automatically
            propagated tags.
        tagMap:
          type: object
          additionalProperties:
            type: string
          description: The tags that will be applied to the created resource.
      required:
      - resourceType
      - tagMap
    TemplateRule:
      type: object
      properties:
        caseRuleId:
          type: string
          description: Unique identifier of a case rule.
        fieldId:
          type: string
          description: Unique identifier of a field.
      required:
      - caseRuleId
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateTemplateRequest:
      type: object
      properties:
        domainId:
          type: string
          description: The unique identifier of the Cases domain.
        templateId:
          type: string
          description: A unique identifier for the template.
        name:
          type: string
          description: The name of the template. It must be unique per domain.
        description:
          type: string
          description: A brief description of the template.
        layoutConfiguration:
          $ref: '#/components/schemas/LayoutConfiguration'
        requiredFields:
          type: array
          items:
            $ref: '#/components/schemas/RequiredField'
          description: A list of fields that must contain a value for a case to be successfully created with this template.
            To require a Customer Profile when creating cases, include customer_id in this list. If customer_id is omitted,
            the Customer Profile field is optional and can be added, changed, or removed after case creation.
        status:
          type: string
          description: The status of the template.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/TemplateRule'
          description: A list of case rules (also known as case field conditions) on a template.
        tagPropagationConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/TagPropagationConfiguration'
          description: Defines tag propagation configuration for resources created within a domain. Tags specified here will
            be automatically applied to resources being created for the specified resource type.
      required:
      - domainId
      - templateId
    UpdateTemplateResponse:
      type: object
      properties: {}
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcases/service/2022-10-03/connectcases-2022-10-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcases/service/2022-10-03/connectcases-2022-10-03.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json