This endpoint is designed to provide updated information on the upload process, ensuring you receive the most recent execution details.

Endpoint Details

URL: https://api.scalemate.co/api/external/creative_sync/{job_id} Method: GET

curl --location 'https://api.scalemate.co/api/external/creative_sync/job_abc123def456' \
--header 'X-Api-Key: <YOUR_API_KEY>'

Response

{
  "job_id": "job_abc123def456",
  "status": "completed",
  "message": "Files uploaded successfully"
}

Status Values

• pending - Job is queued and waiting to be processed

• processing - Job is currently being processed

• completed - Job has finished successfully

• failed - Job has failed due to an error

File Link Formats

The API accepts both Google Drive URLs and file IDs:

• Full URL: https://drive.google.com/file/d/FILE_ID/view

• File ID only: FILE_ID

The system automatically extracts file IDs from full URLs.

The Templates API endpoint retrieves a list of available templates in your Scalemate account.

Endpoint Information

• URL: https://api.scalemate.co/api/external/templates

• Method: GET

Headers

Content-Type: application/json
X-Api-Key: <YOUR_API_KEY>

You can generate the API Key at the Settings page under API Key section

Example cURL Request

curl --location 'https://api.scalemate.co/api/external/templates' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <YOUR_API_KEY>' \

Example Response

{
  "templates": [
    {
      "id": 123,
      "ad_account_id": "12345678901",
      "name": "External Endpoint test"
    }
  ]
}

Scalemate API empowers you to automate your Digital Marketing workflows across platforms like Facebook and TikTok. With a simple and powerful REST API. Designed for seamless integration with tools like Airtable, Make.com, and n8n, the API helps you build custom UA automation flows without relying on manual work.

Whether you're an agency, a performance marketing team, or a no-code builder, Scalemate API gives you the flexibility to move faster, launch smarter, and scale effortlessly.

The Creative Sync API allows external systems to synchronize creative files from Google Drive to advertising platforms through

Endpoint Details

URL: https://api.scalemate.co/api/external/creative_sync Method: POST

Headers

You can generate the API Key at the page under API Key section

Parameters

Example Request Body

Example cURL Request

Example Response

Webhook Response

Follow these steps to start using Scalemate and automate your ad campaigns.

1. Register an Account

Go to and sign up for an account.

2. Create an API Key

Once registered, navigate to the API section in the dashboard and generate your API key. This key will allow you to authenticate your requests to the Scalemate API. Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error. You can generate and manage API keys in .

3. Connect Your Platforms

In the dashboard, connect the platforms you plan to use, such as:

• Facebook

• TikTok

• Google Drive

These integrations will let you upload creative assets and launch campaigns through the API.

4. Create Campaign Templates

Define the campaign setups you use most often by creating templates for Facebook or TikTok. These templates will be used to simplify and speed up campaign launches.

5. Finalize Setup

Ensure your API key is saved and your integrations are working. You’re now ready to use Scalemate to launch campaigns programmatically.

The Launch API endpoint runs your ads through the template you've created at Scalemate

Endpoint Details

URL: https://api.scalemate.co/api/external/v1/launch Method: POST

Headers

Content-Type: application/json
X-Api-Key: <YOUR_API_KEY>

You can generate the API Key at the Settings page under API Key section

Parameters

Example Request Body

You can locate the template_id at the end of the URL within the Scalemate app. For example, in the URL https://app.scalemate.co/workflow/builder/912, the template_id is 912.

{
  "file_links": ["https://drive.google.com/file/d/1JbpRSvif7wR-6vwNA51A5pHcyHViSQ7d/view?usp=drive_link"],
  "template_id": "123",
  "schedule_date": "2024-12-13T12:12:00+01:00" // optional
  "max_creatives_per_adset": 1 // optional
  "webhook_url": "https://webhook.site/your-webhook-url"
}

Example cURL Request

curl --location 'https://api.scalemate.co/api/external/v1/launch' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <YOUR_API_KEY>' \
--data '{
    "file_links": [
        "https://drive.google.com/file/d/1JbpRSvif7wR-6vwNA51A5pHcyHViSQ7d/view?usp=drive_link"
    ],
    "template_id": "123",
    "schedule_date": "2024-12-13T12:12:00+01:00",
    "max_creatives_per_adset": 1,
    "webhook_url": "https://webhook.site/your-webhook-url"
}'

Example Response

{
  "job_id": "63267564-2c14-4ccc-ab60-1a61a950a25d",
  "status": "accepted",
  "message": "Launch job has been accepted and is being processed"
}

Webhook Response

{
  "job_id": "<JOB_ID>",
  "launch_id": "<ID>",
  "status": "success" | "failure",
  "campaigns": [
    {
      "remote_id": "<CAMPAIGN_ID>",
      "name": "<CAMPAIGN_NAME>",
      "adsets": [
        {
          "remote_id": "<ADSET_ID>",
          "name": "<ADSET_NAME>",
          "ads": [
            {
              "remote_id": "<AD_ID>",
              "name": "<FILE_NAME>",
              "bucket_url": "<FILE_URL>"
            }
          ]
        },
		    ...
      ]
    }
  ],
  "error": null,
  "completed_at": "<DATE>"
}