> ## 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. # Create a shareable (legacy) > Deprecated. Use `POST /api/v6/me/shareables` instead. Creates a shareable for the authenticated consumer. ## OpenAPI ````yaml /api-reference/integration-consumer-to-extole.json post /api/v4/shareable 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/v4/shareable: post: tags: - Profiles summary: Create a shareable (legacy) description: >- Deprecated. Use `POST /api/v6/me/shareables` instead. Creates a shareable for the authenticated consumer. operationId: createShareable requestBody: content: application/json: example: access_token: access_token code: code content: description: description image_url: image_url partner_content_id: partner_content_id title: title url: url key: key label: label target_url: target_url schema: $ref: '#/components/schemas/CreateShareableV4Request' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateShareableV4Response' description: Successful response '400': content: application/json: examples: EXISTING_LINK: $ref: '#/components/examples/EXISTING_LINK' INVALID_IMAGE_URL: $ref: '#/components/examples/INVALID_IMAGE_URL' INVALID_PARTNER_CONTENT_URL: $ref: '#/components/examples/INVALID_PARTNER_CONTENT_URL' INVALID_SHARE_URL: $ref: '#/components/examples/INVALID_SHARE_URL' INVALID_TARGET_URL: $ref: '#/components/examples/INVALID_TARGET_URL' INVALID_URL_FORMAT: $ref: '#/components/examples/INVALID_URL_FORMAT' NON_EXISTING_LINK: $ref: '#/components/examples/NON_EXISTING_LINK' UNREWARDABLE: $ref: '#/components/examples/UNREWARDABLE' binding_error: $ref: '#/components/examples/binding_error' code_illegal_character: $ref: '#/components/examples/code_illegal_character' code_out_of_range: $ref: '#/components/examples/code_out_of_range' code_profane_word: $ref: '#/components/examples/code_profane_word' code_taken_by_promotion: $ref: '#/components/examples/code_taken_by_promotion' content_description_length_exceeded: $ref: '#/components/examples/content_description_length_exceeded' 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 extole_destination_length_out_of_range: $ref: '#/components/examples/extole_destination_length_out_of_range' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_shareable_id: $ref: '#/components/examples/invalid_shareable_id' key_taken: $ref: '#/components/examples/key_taken' label_name_contains_illegal_character: $ref: '#/components/examples/label_name_contains_illegal_character' label_name_out_of_range: $ref: '#/components/examples/label_name_out_of_range' missing_request_body: $ref: '#/components/examples/missing_request_body' person_not_found: $ref: '#/components/examples/person_not_found' target_url_length_out_of_range: $ref: '#/components/examples/target_url_length_out_of_range' 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' code_contains_reserved_word: $ref: '#/components/examples/code_contains_reserved_word' expired_access_token: $ref: '#/components/examples/expired_access_token' invalid_access_token: $ref: '#/components/examples/invalid_access_token' jwt_authentication_error: $ref: '#/components/examples/jwt_authentication_error' 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 deprecated: true components: schemas: CreateShareableV4Request: properties: access_token: nullable: true type: string writeOnly: true code: nullable: true type: string content: $ref: '#/components/schemas/ShareableV4Content' key: nullable: true type: string label: nullable: true type: string target_url: type: string required: - code - content - key - label - target_url type: object CreateShareableV4Response: properties: polling_id: type: string shareable_code: type: string shareable_domain: type: string shareable_id: type: string shareable_program_id: type: string required: - polling_id - shareable_code - shareable_domain - shareable_id - shareable_program_id 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 ShareableV4Content: 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: EXISTING_LINK: summary: EXISTING_LINK value: code: EXISTING_LINK http_status_code: 400 message: Link already exists. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 INVALID_IMAGE_URL: summary: INVALID_IMAGE_URL value: code: INVALID_IMAGE_URL http_status_code: 400 message: Invalid image URL. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 INVALID_PARTNER_CONTENT_URL: summary: INVALID_PARTNER_CONTENT_URL value: code: INVALID_PARTNER_CONTENT_URL http_status_code: 400 message: Invalid partner content URL. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 INVALID_SHARE_URL: summary: INVALID_SHARE_URL value: code: INVALID_SHARE_URL http_status_code: 400 message: Invalid share URL. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 INVALID_TARGET_URL: summary: INVALID_TARGET_URL value: code: INVALID_TARGET_URL http_status_code: 400 message: Invalid target URL. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 INVALID_URL_FORMAT: summary: INVALID_URL_FORMAT value: code: INVALID_URL_FORMAT http_status_code: 400 message: Invalid URL format for URL. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 NON_EXISTING_LINK: summary: NON_EXISTING_LINK value: code: NON_EXISTING_LINK http_status_code: 400 message: Link doesn't exist for update. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 UNREWARDABLE: summary: UNREWARDABLE value: code: UNREWARDABLE http_status_code: 400 message: User must have an associated email to create a shareable. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 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 code_illegal_character: summary: code_illegal_character value: code: code_illegal_character http_status_code: 403 message: Code can only contain alphanumeric, dash and underscore parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 code_out_of_range: summary: code_out_of_range value: code: code_out_of_range http_status_code: 403 message: Code length must be between 4 and 50 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 code_profane_word: summary: code_profane_word value: code: code_profane_word http_status_code: 400 message: Code contains profane word parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 code_taken_by_promotion: summary: code_taken_by_promotion value: code: code_taken_by_promotion http_status_code: 400 message: >- The code associated with this shareable is already used by a promotion link parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 content_description_length_exceeded: summary: content_description_length_exceeded value: code: content_description_length_exceeded http_status_code: 403 message: Content description length exceeded 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 extole_destination_length_out_of_range: summary: extole_destination_length_out_of_range value: code: extole_destination_length_out_of_range http_status_code: 400 message: Extole destination length is out of range. Max 2000 chars 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 invalid_shareable_id: summary: invalid_shareable_id value: code: invalid_shareable_id http_status_code: 400 message: Invalid shareable id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 key_taken: summary: key_taken value: code: key_taken http_status_code: 403 message: The key associated with this shareable has already been specified 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_out_of_range: summary: label_name_out_of_range value: code: label_name_out_of_range http_status_code: 400 message: Label name is not of valid length 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 person_not_found: summary: person_not_found value: code: person_not_found http_status_code: 403 message: Person not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 target_url_length_out_of_range: summary: target_url_length_out_of_range value: code: target_url_length_out_of_range http_status_code: 403 message: Target URL length is out of range. Max 2000 chars 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 code_contains_reserved_word: summary: code_contains_reserved_word value: code: code_contains_reserved_word http_status_code: 403 message: Shareable code contains reserved word 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 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 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 ````