Overview
The Signal Genesys External API allows you to automate press release creation and publishing directly within Search Atlas. This article explains what to prepare, what to expect, and how to escalate effectively if you encounter issues. Because this is a backend-assisted integration, some steps — such as credential provisioning, entity linking, and endpoint configuration — require the support team to complete setup on your account before you can proceed.
What to Prepare Before You Start
Before contacting the support team to enable the Signal Genesys External API integration, gather the following information. Having this ready will allow the team to configure your account in a single interaction:
- Your Search Atlas account email address — used to locate your account and assign API credentials.
- The name of the project or integration you are building — helps the team provision the correct access scope.
- The entity name you plan to associate with press releases — entities must exist and be linked to your account before API submissions will succeed.
- Any error messages already encountered, including the exact error text and the timestamp of the failed request.
Authentication Setup
Signal Genesys API requests require authentication credentials tied to your Search Atlas account. These credentials are not self-provisioned — they are assigned by the support team based on your plan and integration requirements. To initiate this process:
- Log in to your Search Atlas account and navigate to Avatar → Settings → API Keys to confirm whether an API key or token is already present.
- If no credential is visible, open the chat widget and request API access. Provide your account email, project name, and intended use case so the team can assign the correct credential type.
- Once credentials are issued, store them securely. The team will confirm the exact authentication header or parameter format required for your account configuration.
Entity Management
Every press release submitted via the API must be associated with a valid entity in your Search Atlas workspace. Entity linking is managed on the backend. If you receive a validation error related to an entity, this typically means one of the following:
- The entity does not yet exist in your account and needs to be created by the support team.
- The entity exists but is not linked to the correct workspace or project.
- The entity name or identifier in your API request does not match the value stored on your account.
When escalating an entity error, have ready: your account email, your organisation name, the exact error message returned by the API, and the timestamp of the failed request. The support team will identify which of the above applies and resolve it on the backend.
Publishing a Press Release
Once your credentials and entity are confirmed, press release submission via the External API follows this general flow:
- Review the API documentation or developer resources available inside your Search Atlas account dashboard. These resources contain the endpoint path, required parameters, and accepted field values specific to your account configuration.
- Construct your API request using the credentials issued to you. Include the entity identifier, press release content fields, and any distribution or variant parameters documented for your account.
- Submit a test request before going live. Capture the full API response, including the status code, any error codes, and the response body.
- If the test response indicates a configuration issue — such as an unrecognised entity, an invalid parameter, or an authentication failure — escalate to support with your account email, a description of the workflow you are automating, and the full error response including timestamps.
Endpoint paths and required field names are account-specific and provided directly by the support team during onboarding. Do not share your API credentials in any support conversation.
Credit Usage
Credits may be deducted when a press release is submitted via the API. To avoid unexpected deductions:
- Confirm with the support team how many credits a single API submission consumes on your plan before running bulk submissions.
- Use test mode or a staging environment if one is available for your account, so that exploratory submissions do not consume production credits.
- If you notice an unexpected credit deduction after a submission, note the press release ID or submission timestamp from the API response before escalating.
When reporting a credit discrepancy, provide your account email, the press release ID or submission timestamp, and the credit balance before and after the deduction if visible in your dashboard.
Status Tracking
After a press release is submitted, its publishing status is returned in the API response and may also be visible in your Search Atlas dashboard. Common status values include submitted, processing, published, and failed. If a submission enters a failed or stuck state, escalate with the press release ID, the status value returned, and the timestamp of the original submission so the support team can investigate the backend workflow.
If you need further assistance, open the chat widget in the bottom-right corner of the platform and type human teammate to be connected with a member of our team.