> ## 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. # Submit a custom share event > Deprecated. Use event-based sharing instead. Records a custom share on behalf of the authenticated advocate and returns a `polling_id` for status polling. ## OpenAPI ````yaml /api-reference/integration-consumer-to-extole.json post /api/v5/custom/share 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/v5/custom/share: post: tags: - Profiles summary: Submit a custom share event description: >- Deprecated. Use event-based sharing instead. Records a custom share on behalf of the authenticated advocate and returns a `polling_id` for status polling. operationId: customShare requestBody: content: application/json: example: advocate_code: advocate_code channel: channel data: data_key: data_key message: message recipient_email: recipient_email schema: $ref: '#/components/schemas/CustomShareRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomShareResponse' description: Successful response '400': content: application/json: examples: ADVOCATE_CODE_MISSING: $ref: '#/components/examples/ADVOCATE_CODE_MISSING' ADVOCATE_CODE_NOT_FOUND: $ref: '#/components/examples/ADVOCATE_CODE_NOT_FOUND' CHANNEL_MISSING: $ref: '#/components/examples/CHANNEL_MISSING' INVALID_MESSAGE_LENGTH: $ref: '#/components/examples/INVALID_MESSAGE_LENGTH' INVALID_RECIPIENT: $ref: '#/components/examples/INVALID_RECIPIENT' INVALID_SHARE_MESSAGE_CHARACTERS: $ref: '#/components/examples/INVALID_SHARE_MESSAGE_CHARACTERS' INVALID_SHARE_MESSAGE_LINK: $ref: '#/components/examples/INVALID_SHARE_MESSAGE_LINK' MISSING_MESSAGE: $ref: '#/components/examples/MISSING_MESSAGE' MISSING_RECIPIENT: $ref: '#/components/examples/MISSING_RECIPIENT' binding_error: $ref: '#/components/examples/binding_error' 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' 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: CustomShareRequest: properties: advocate_code: type: string channel: type: string data: additionalProperties: type: string type: object message: type: string recipient_email: type: string required: - advocate_code - channel - data - message - recipient_email type: object CustomShareResponse: properties: polling_id: type: string share_id: type: string required: - polling_id - share_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 examples: ADVOCATE_CODE_MISSING: summary: ADVOCATE_CODE_MISSING value: code: ADVOCATE_CODE_MISSING http_status_code: 400 message: advocate_code is required in the share request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 ADVOCATE_CODE_NOT_FOUND: summary: ADVOCATE_CODE_NOT_FOUND value: code: ADVOCATE_CODE_NOT_FOUND http_status_code: 400 message: Advocate code not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 CHANNEL_MISSING: summary: CHANNEL_MISSING value: code: CHANNEL_MISSING http_status_code: 400 message: Channel is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 INVALID_MESSAGE_LENGTH: summary: INVALID_MESSAGE_LENGTH value: code: INVALID_MESSAGE_LENGTH http_status_code: 400 message: Share message cannot exceed 2048 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 INVALID_RECIPIENT: summary: INVALID_RECIPIENT value: code: INVALID_RECIPIENT http_status_code: 400 message: Recipient has a wrong syntax. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 INVALID_SHARE_MESSAGE_CHARACTERS: summary: INVALID_SHARE_MESSAGE_CHARACTERS value: code: INVALID_SHARE_MESSAGE_CHARACTERS http_status_code: 400 message: Sorry, we can not put these characters in a share message. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 INVALID_SHARE_MESSAGE_LINK: summary: INVALID_SHARE_MESSAGE_LINK value: code: INVALID_SHARE_MESSAGE_LINK http_status_code: 400 message: Sorry, we can not put that link in a share message. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 MISSING_MESSAGE: summary: MISSING_MESSAGE value: code: MISSING_MESSAGE http_status_code: 400 message: Share message is missing. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 MISSING_RECIPIENT: summary: MISSING_RECIPIENT value: code: MISSING_RECIPIENT http_status_code: 400 message: Recipient is missing. 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 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 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 ````