> ## Documentation Index
> Fetch the complete documentation index at: https://doc.extole.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get or create a shareable

> Returns an existing shareable matching the request criteria or creates one if none exists. Idempotent helper for mobile and headless integrations.



## OpenAPI

````yaml /api-reference/integration-consumer-to-extole.json post /api/v6/me/shareables/get-or-create
openapi: 3.0.1
info:
  description: >-
    Consumer-to-Extole integration endpoints: consumer event submission, zone
    rendering, profile management, and SDK-backing operations for browser and
    native app environments.
  title: Integration API - Consumer to Extole
  version: '1.0'
servers:
  - description: Production
    url: https://{brand}.extole.io
    variables:
      brand:
        default: yourcompany
        description: >-
          Your Extole client subdomain (e.g. 'mycompany' for
          mycompany.extole.io)
security:
  - HEADER: []
  - QUERY: []
  - COOKIE: []
tags:
  - name: Authentication
  - name: Content
  - name: Email
  - name: Events
  - name: Persons
  - name: Profile Assets
  - name: Profiles
paths:
  /api/v6/me/shareables/get-or-create:
    post:
      tags:
        - Profiles
      summary: Get or create a shareable
      description: >-
        Returns an existing shareable matching the request criteria or creates
        one if none exists. Idempotent helper for mobile and headless
        integrations.
      operationId: getOrCreate
      requestBody:
        content:
          application/json:
            example:
              content:
                description: description
                image_url: image_url
                partner_content_id: partner_content_id
                title: title
                url: url
              data:
                data_key: data_key
              key: key
              label: label
              preferred_code_prefixes:
                - preferred_code_prefixe
            schema:
              $ref: '#/components/schemas/CreateMeShareableRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeShareableResponse'
          description: Successful response
        '400':
          content:
            application/json:
              examples:
                binding_error:
                  $ref: '#/components/examples/binding_error'
                content_url_length_out_of_range:
                  $ref: '#/components/examples/content_url_length_out_of_range'
                invalid_json:
                  $ref: '#/components/examples/invalid_json'
                invalid_parameter:
                  $ref: '#/components/examples/invalid_parameter'
                missing_request_body:
                  $ref: '#/components/examples/missing_request_body'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              examples:
                method_unauthorized:
                  $ref: '#/components/examples/method_unauthorized'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              examples:
                access_denied:
                  $ref: '#/components/examples/access_denied'
                blocked_content_url:
                  $ref: '#/components/examples/blocked_content_url'
                content_image_url_invalid:
                  $ref: '#/components/examples/content_image_url_invalid'
                data_attribute_name_invalid:
                  $ref: '#/components/examples/data_attribute_name_invalid'
                data_attribute_name_length_out_of_range:
                  $ref: >-
                    #/components/examples/data_attribute_name_length_out_of_range
                data_attribute_value_invalid:
                  $ref: '#/components/examples/data_attribute_value_invalid'
                data_attribute_value_length_out_of_range:
                  $ref: >-
                    #/components/examples/data_attribute_value_length_out_of_range
                expired_access_token:
                  $ref: '#/components/examples/expired_access_token'
                invalid_access_token:
                  $ref: '#/components/examples/invalid_access_token'
                invalid_content_url:
                  $ref: '#/components/examples/invalid_content_url'
                jwt_authentication_error:
                  $ref: '#/components/examples/jwt_authentication_error'
                label_name_contains_illegal_character:
                  $ref: '#/components/examples/label_name_contains_illegal_character'
                label_name_length_out_of_range:
                  $ref: '#/components/examples/label_name_length_out_of_range'
                method_unauthorized:
                  $ref: '#/components/examples/method_unauthorized'
                missing_access_token:
                  $ref: '#/components/examples/missing_access_token'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Forbidden
        '415':
          content:
            application/json:
              examples:
                unsupported_media_type:
                  $ref: '#/components/examples/unsupported_media_type'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Unsupported Media Type
        '429':
          content:
            application/json:
              examples:
                too_many_requests:
                  $ref: '#/components/examples/too_many_requests'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Too Many Requests
components:
  schemas:
    CreateMeShareableRequest:
      properties:
        content:
          $ref: '#/components/schemas/ShareableContent'
        data:
          additionalProperties:
            type: string
          nullable: true
          type: object
        key:
          nullable: true
          type: string
        label:
          type: string
        preferred_code_prefixes:
          items:
            type: string
          nullable: true
          type: array
      required:
        - content
        - data
        - key
        - label
        - preferred_code_prefixes
      type: object
    MeShareableResponse:
      properties:
        code:
          type: string
        content:
          $ref: '#/components/schemas/ShareableContent'
        data:
          additionalProperties:
            type: string
          nullable: true
          type: object
        key:
          type: string
        label:
          nullable: true
          type: string
        link:
          type: string
      required:
        - code
        - content
        - data
        - key
        - label
        - link
      type: object
    RestExceptionResponse:
      description: Represents the API error response
      properties:
        code:
          description: Specific error code for this error type, documented per endpoint
          type: string
        http_status_code:
          description: >-
            HTTP status code that was returned with this error, useful if client
            get response code
          format: int32
          type: integer
        message:
          description: User readable English description of the error
          type: string
        parameters:
          additionalProperties:
            description: >-
              Attributes related to the error, varies be error code, documented
              per endpoint
            type: object
          description: >-
            Attributes related to the error, varies be error code, documented
            per endpoint
          type: object
        unique_id:
          description: >-
            Unique id associated with this error, useful for discussions with
            Extole
          type: string
      required:
        - code
        - http_status_code
        - message
        - parameters
        - unique_id
      type: object
    ShareableContent:
      nullable: true
      properties:
        description:
          nullable: true
          type: string
        image_url:
          nullable: true
          type: string
        partner_content_id:
          nullable: true
          type: string
        title:
          nullable: true
          type: string
        url:
          nullable: true
          type: string
      type: object
  examples:
    binding_error:
      summary: binding_error
      value:
        code: binding_error
        http_status_code: 400
        message: Argument is not of the expected type
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    content_url_length_out_of_range:
      summary: content_url_length_out_of_range
      value:
        code: content_url_length_out_of_range
        http_status_code: 400
        message: Content url is out of range
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    invalid_json:
      summary: invalid_json
      value:
        code: invalid_json
        http_status_code: 400
        message: JSON is invalid
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    invalid_parameter:
      summary: invalid_parameter
      value:
        code: invalid_parameter
        http_status_code: 400
        message: Parameter is invalid.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    missing_request_body:
      summary: missing_request_body
      value:
        code: missing_request_body
        http_status_code: 400
        message: Missing request body
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    method_unauthorized:
      summary: method_unauthorized
      value:
        code: method_unauthorized
        http_status_code: 401
        message: Unauthorized access to this endpoint
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    access_denied:
      summary: access_denied
      value:
        code: access_denied
        http_status_code: 403
        message: >-
          The access_token provided is not permitted to access the specified
          resource.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    blocked_content_url:
      summary: blocked_content_url
      value:
        code: blocked_content_url
        http_status_code: 403
        message: Content url is blocked
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    content_image_url_invalid:
      summary: content_image_url_invalid
      value:
        code: content_image_url_invalid
        http_status_code: 403
        message: Invalid content image_url
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    data_attribute_name_invalid:
      summary: data_attribute_name_invalid
      value:
        code: data_attribute_name_invalid
        http_status_code: 403
        message: Shareable data attribute name is invalid
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    data_attribute_name_length_out_of_range:
      summary: data_attribute_name_length_out_of_range
      value:
        code: data_attribute_name_length_out_of_range
        http_status_code: 403
        message: Shareable data attribute name length is out of range. Max 200 chars
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    data_attribute_value_invalid:
      summary: data_attribute_value_invalid
      value:
        code: data_attribute_value_invalid
        http_status_code: 403
        message: Shareable data value is invalid
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    data_attribute_value_length_out_of_range:
      summary: data_attribute_value_length_out_of_range
      value:
        code: data_attribute_value_length_out_of_range
        http_status_code: 403
        message: Shareable data attribute value length is out of range. Max 2000 chars
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    expired_access_token:
      summary: expired_access_token
      value:
        code: expired_access_token
        http_status_code: 403
        message: The access_token provided with this request has expired.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    invalid_access_token:
      summary: invalid_access_token
      value:
        code: invalid_access_token
        http_status_code: 403
        message: The access_token provided with this request is invalid.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    invalid_content_url:
      summary: invalid_content_url
      value:
        code: invalid_content_url
        http_status_code: 403
        message: Invalid content url
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    jwt_authentication_error:
      summary: jwt_authentication_error
      value:
        code: jwt_authentication_error
        http_status_code: 403
        message: The jwt authentication failed.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    label_name_contains_illegal_character:
      summary: label_name_contains_illegal_character
      value:
        code: label_name_contains_illegal_character
        http_status_code: 403
        message: >-
          Label name can only contain alphanumeric, dash and underscore
          characters
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    label_name_length_out_of_range:
      summary: label_name_length_out_of_range
      value:
        code: label_name_length_out_of_range
        http_status_code: 403
        message: Label name is not of valid length
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    missing_access_token:
      summary: missing_access_token
      value:
        code: missing_access_token
        http_status_code: 403
        message: No access_token was provided with this request.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    unsupported_media_type:
      summary: unsupported_media_type
      value:
        code: unsupported_media_type
        http_status_code: 415
        message: Request had an unsupported or no media type
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    too_many_requests:
      summary: too_many_requests
      value:
        code: too_many_requests
        http_status_code: 429
        message: >-
          The server is unable to process your request at the moment, please
          retry later.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
  securitySchemes:
    HEADER:
      in: header
      name: Authorization
      type: apiKey
      x-bearer-format: bearer
    QUERY:
      in: query
      name: access_token
      type: apiKey
    COOKIE:
      in: cookie
      name: extole_token
      type: apiKey

````