Cobot Built-in Email Customizations API

openapi: 3.2.0
info:
  title: Cobot Built-in Email Customizations API
  termsOfService: https://www.cobot.me/terms
  x-logo:
    url: /api2_logo.webp
    backgroundColor: '#FFFFFF'
    altText: Cobot logo
  description: This is the 2.0 version of the Cobot API.
  version: '2.0'
  contact:
    name: Cobot Support
    url: https://dev.cobot.me/
    email: support@cobot.me
servers:
- url: https://api.cobot.me
security:
- OAuth2: []
tags:
- name: Built-in Email Customizations
  description: Email customizations for emails that can be sent via Cobot.
paths:
  /spaces/{spaceId}/built_in_email_customizations:
    get:
      summary: For Space
      description: 'List all email customizations for built-in emails for a space, including used placeholders.


        **Access**: The current user must be an admin of the space.'
      operationId: get-built-in-email-customizations
      parameters:
      - name: spaceId
        in: path
        required: true
        description: The id of the space to get the email customizations for.
        schema:
          type: string
      security:
      - OAuth2:
        - read_built_in_email_customizations
      tags:
      - Built-in Email Customizations
      responses:
        '200':
          description: All email customizations for built-in emails for a space.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/built_in_email_customizations'
              examples:
                default:
                  value:
                    data:
                    - id: email-customization-space-demo-membership_confirmation_email
                      type: builtInEmailCustomizations
                      attributes:
                        name: Membership confirmation
                        key: membership_confirmation_email
                        description: This email gets sent after confirming a new member.
                        subject: Membership Confirmation for {{space}}
                        subjectPlaceholders:
                          space: Demo Space
                        body: <p>Hi {{first_name}},<br>your membership at {{space}} has been confirmed.</p>
                        bodyPlaceholders:
                          first_name: Petra
                          space: Demo Space
                      relationships:
                        space:
                          data:
                            id: a927aa71ac8df98d29de357180d275a2
                            type: spaces
                      links:
                        self: https://api.cobot.me/spaces/a927aa71ac8df98d29de357180d275a2/built_in_email_customizations/membership_confirmation_email
  /spaces/{spaceId}/built_in_email_customizations/{key}:
    get:
      summary: Get built-in email customization
      description: 'Get a built-in email customization via its key.


        **Access**: The current user must be an admin of the space.'
      operationId: get-built-in-email-customization
      parameters:
      - name: spaceId
        in: path
        required: true
        description: The id of the space to get the email customization for.
        schema:
          type: string
      - name: key
        in: path
        required: true
        description: The key by which the email customization is requested.
        schema:
          type: string
      security:
      - OAuth2:
        - read_built_in_email_customizations
      tags:
      - Built-in Email Customizations
      responses:
        '200':
          description: An email customization for a built-in email.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/built_in_email_customization'
              examples:
                default:
                  value:
                    data:
                      id: email-customization-space-demo-membership_confirmation_email
                      type: builtInEmailCustomizations
                      attributes:
                        name: Membership confirmation
                        key: membership_confirmation_email
                        description: This email gets sent after confirming a new member.
                        subject: Membership Confirmation for {{space}}
                        subjectPlaceholders:
                          space: Demo Space
                        body: <p>Hi {{first_name}},<br>your membership at {{space}} has been confirmed.</p>
                        bodyPlaceholders:
                          first_name: Petra
                          space: Demo Space
                      relationships:
                        space:
                          data:
                            id: a927aa71ac8df98d29de357180d275a2
                            type: spaces
                      links:
                        self: https://api.cobot.me/spaces/a927aa71ac8df98d29de357180d275a2/built_in_email_customizations/membership_confirmation_email
components:
  schemas:
    -built-in-email-customization-data:
      id: -built-in-email-customization-data.json
      type: object
      required:
      - id
      - type
      additionalProperties: false
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
          required:
          - name
          - key
          - description
          - subject
          - subjectPlaceholders
          - body
          - bodyPlaceholders
          additionalProperties: false
          properties:
            name:
              type: string
            key:
              type: string
            description:
              type: string
            subject:
              type: string
            subjectPlaceholders:
              type: object
            body:
              type: string
            bodyPlaceholders:
              type: object
        relationships:
          type: object
          required:
          - space
          additionalProperties: false
          properties:
            space:
              $ref: '#/components/schemas/relationship-linkage'
        links:
          type: object
          properties:
            self:
              type: string
              format: uri-reference
          additionalProperties: false
    linkage:
      description: The "type" and "id" of a linked entity.
      type: object
      required:
      - type
      - id
      properties:
        type:
          type: string
        id:
          type: string
      additionalProperties: false
    relationship-linkage:
      type: object
      required:
      - data
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/linkage'
    built_in_email_customizations:
      id: built_in_email_customizations.json#
      type: object
      required:
      - data
      additionalProperties: false
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/-built-in-email-customization-data'
    built_in_email_customization:
      id: built_in_email_customization.json#
      type: object
      required:
      - data
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/-built-in-email-customization-data'
  securitySchemes:
    OpenId:
      type: openIdConnect
      openIdConnectUrl: https://www.cobot.me/.well-known/openid-configuration
    OAuth2:
      type: oauth2
      description: "OAuth is \"an open protocol to allow secure API authorization in a simple and\nstandard method from desktop and web applications.\". \"OAuth 2.0 is the\nnext evolution of the OAuth protocol [..]. OAuth 2.0 focuses on client\ndeveloper simplicity [...]. It is supported by many popular sites such as\nFacebook and there are client libraries available for many programming\nlanguages.\n\nFor information about OAuth2 see the [oauth website](http://oauth.net/2/).\n\n**For OAuth2 you need a client id and secret. In order to get those you have\nto [register your application](/oauth2_clients).**\n\nAPI authorization works by passing a bearer token via the HTTP Authorization header:\n\n    Authorization: bearer <token>\n\n## Permissions (Scope)\n\nOAuth2 [defines scopes](https://tools.ietf.org/html/rfc6749#section-3.3) to\nrestrict access to certain resources.\n\nThe required scope for each resource can be found within the documentation\nfor each endpoint.\n\nPlease note that a user's scope can be limited when they access the API as\nan admin of a space and some of their admin permissions have been revoked.\n"
      flows:
        authorizationCode:
          authorizationUrl: https://www.cobot.me/oauth/authorize
          tokenUrl: https://www.cobot.me/oauth/access_token
          scopes:
            read_articles: Read help desk articles.
            read_allocations: Read resource allocation data.
            read_booking_credits: Read information about a membership's booking credits.
            read_bookings: Read booking data.
            read_built_in_email_customizations: Read built in email customizations.
            read_calendar_blockers: Read calendar blockers.
            read_check_ins: Read memberships' check-in data.
            read_contacts: Read contacts.
            read_drop_in_passes: Read drop-in passes.
            read_drop_in_pass_templates: Read drop-in pass templates.
            read_discount_codes: Read discount codes.
            read_event_attendances: Read who is attending an event.
            read_event_messages: Read messages sent about events.
            read_events: Read events of a space.
            read_external_bookings: Read external booking data.
            read_external_resources: Read resources enabled for external booking.
            read_invoices: Read invoices created for a membership in a space.
            read_memberships: Read information about memberships in a space.
            read_teams: Read information about teams in a space.
            read_membership_profiles: Read members' profile data.
            read_navigation_links: Read/list navigation links for a space.
            read_payment_methods: Read payment methods in order to process payments.
            read_published_membership_profiles: Read published members' profile data.
            read_networks: Read information about a network.
            read_products: Read information about products.
            read_resource_categories: Read information about booking calendar categories.
            read_resources: Read information about booking calendar resources.
            read_single_page_apps: Read information about single page apps.
            read_space_profiles: Read space profile information.
            read_spaces: Read basic space information.
            read_space_billing_details: Read information relevant to billing the space.
            read_space_payment_method: Read a space's payment method used to pay for the space's Cobot subscription.
            read_space_subscriptions: Read a space's subscription.
            read_terms_approvals: Shows missing approvals for the current member.
            read_urls: Read the URLs to the Cobot web interface.
            read_user: Read the current user's information.
            write_bookings: Write booking data.
            write_check_ins: Check a member in at a space.
            write_customers: Convert a space to a customer.
            write_drop_in_pass_purchases: Create drop-in pass purchases.
            write_drop_in_passes: Cancel drop-in passes.
            write_event_ticket_purchases: Create event ticket purchases.
            write_event_attendances: Attend/unattend events.
            write_event_messages: Create/update messages sent about events.
            write_events: Write to events of a space.
            write_external_bookings: Create/update bookings as a non-member.
            write_external_resources: Create/update/delete resources enabled for non-memberss
            write_resources: Create/update/delete booking calendar resources.
            write_invoices: Create invoices for members in a space.
            write_invoice_reminders: Send invoice reminder emails.
            write_membership_profiles: Manage the social profiles of members.
            write_navigation_links: Create/update/delete navigation links for a space.
            write_payments: Initiate payments for external bookings.
            write_single_page_apps: Create and update single page apps to be embedded on Cobot.
            write_space_billing_details: Update a space's billing details.
            write_space_payment_method: Update a space's payment method used to pay for the space's Cobot subscription.
            write_space_subscriptions: Change a space's subscription. Only trusted clients can request this scope. Contact support.
            write_terms_approvals: Approve different kinds of terms as a member.