Delay

The Delay endpoint calculates the optimal send time for a template variant. Use it to implement send-time optimization — scheduling messages to arrive when each user is most likely to engage.

Endpoint

GET https://worker.justwords.ai/api/delay/:org_slug

Authentication

This endpoint requires authentication via an API key. Include your key in the X-Api-Key header or as a Bearer token in the Authorization header.

See the Quickstart for details on creating and managing API keys.

Request

Path Parameters

Parameter	Type	Required	Description
org_slug	string	Yes	Your organization identifier (e.g., your-company-name).

Query Parameters

Parameter	Type	Required	Description
delay_id	string	Yes	The variant ID to calculate a delay for (typically from a prior Generate response).
user_id	string	No	Unique identifier for the end user (used for per-user optimization).
email	string	No	Email address of the end user (alternative to user_id).

Examples

Basic Request

cURL

curl "https://worker.justwords.ai/api/delay/your-org?delay_id=variant_abc123&user_id=user_123" \
  -H "X-Api-Key: your_api_key"

JavaScript

const params = new URLSearchParams({
  delay_id: 'variant_abc123',
  user_id: 'user_123',
});

const response = await fetch(
  `https://worker.justwords.ai/api/delay/your-org?${params}`,
  {
    headers: {
      'X-Api-Key': 'your_api_key',
    },
  }
);

const data = await response.json();
console.log(data.just_words);

Python

import requests

url = "https://worker.justwords.ai/api/delay/your-org"
headers = {
    "X-Api-Key": "your_api_key"
}
params = {
    "delay_id": "variant_abc123",
    "user_id": "user_123"
}

response = requests.get(url, headers=headers, params=params)
data = response.json()
print(data["just_words"])

Typical Workflow

1. Call the Generate endpoint to select a variant.
2. Pass the returned copy.id as the delay_id to this endpoint.
3. Schedule your message to send at the returned delay_time.

Response

Success Response (200 OK)

{
  "just_words": {
    "delay_id": "variant_abc123",
    "delay_time": "2024-01-15T14:30:00.000Z"
  }
}

Response Fields

Field	Type	Description
just_words.delay_id	string	The variant ID that was evaluated.
just_words.delay_time	string	ISO-8601 timestamp indicating when the message should be sent.

Note

If no optimal send time can be determined (e.g., insufficient engagement data for this user), the endpoint falls back to a 24-hour delay from the current time.