Provide custom flexpane behavior for Work Objects. Apps call this endpoint to send per-user flexpane metadata to the client.

Required Params

• trigger_id - A reference to the original user action that initiated the request.

Optional Params

• error -
• metadata - URL-encoded JSON object containing flexpane metadata from the app that will be conformed to a Work Object metadata schema, keyed by entity ID.
• user_auth_required - Set to true (or 1) to indicate that the user must authenticate to view full flexpane data.
• user_auth_url - A custom URL to which users are directed for authentication if required. ex: https://example.com/onboarding?user_id=xxx

Errors the API can return:

• entity_metadata_does_not_match_trigger - The provided entity's ID does not match the ID of the entity used to initiate the request
• feature_not_enabled - temporarily gating API
• invalid_app_id - App ID is not a valid format
• invalid_metadata - The provided metadata argument could not be parsed or understood.
• invalid_trigger_id - Trigger id is not valid
• missing_interactivity_url - App does not have an interactivity URL configured
• missing_options_load_url - App does not have an options load URL configured
• user_auth_url_missing - User auth url is required if user_auth_required is true

See the Common Errors guide for errors returned by every Web API method.