Focus USA’s Optout API is provided as a RESTful web service.
You will need to send an HTTP POST request to the API endpoint specifying your API key, a content-type header and your query. You will receive a JSON-formatted response.
The API Endpoint #
The Focus USA API is located at: https://api.focususaconnect.com/
- The specific endpoint for this service is – api.focususaconnect.com/optout
Authentication #
Authentication is handled via API key.
- Add the header x-api-key to your API calls. Contact your sales rep or info@focus-usa.com to request a key.
Rate Limiting #
By default, accounts are limited to 10 requests per second (600 requests per minute). This can be increased upon request.
Metadata #
The following fields can be passed in the body of the request. You can provide only the fields you require. Field names ARE CASE SENSITIVE.
Request (Input)
| FIELD NAME | DESCRIPTION | EXAMPLE |
|---|---|---|
| first_name | First Name | ABC |
| middle_name | Middle Name | D |
| last_name | Last Name | EFGH |
| street | Full Street Address | 123 MAIN ST APT 5 |
| city | City Name | AGAWAM |
| state | State Abbreviation | MA |
| zip | Zip Code | 01001 |
| Email Address | ABC@GMAIL.COM | |
| phone | Phone | 1234567899 |
| reference_id | Your ID for the request, if needed for confirmation. | ABC123 |
| email2 | Secondary email | ABC2@GMAIL.COM |
| email3 | Additional email | ABC3@GMAIL.COM |
| phone2 | Secondary Phone | 3456789912 |
| phone3 | Additional Phone | 4567899123 |
| address | Full Address (Comma Separated) | 123 MAIN ST APT 5, AGAWAM, MA, 01001 |
Response (Output)
The JSON response returns three values. The reference ID provided with the request, the status (completed, processing, failed) and reason in case of failure.
{
"reference_id": "abc123",
"status": "completed",
"reason": "null"
}Examples #
cURL
curl --location --request POST 'https://api.focususaconnect.com/optout' \
--header 'x-api-key: YOUR-API-KEY-HERE' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "ABC",
"last_name": "DEF",
"street": "123 MAIN ST APT 5",
"city": "AGAWAM",
"state": "MA",
"zip": "01001",
"reference_id": "abc123"
}Successful Response:
{
"reference_id": "abc123",
"status": "completed",
"reason": "null"
}