Update a Creative

curl -X PUT "https://api.tracklysms.com/api/v2/creatives/101" \
  -H "X-Api-Key: trk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer Sale Promo v2",
    "message": "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
    "offer_links": [
      {
        "key": "link1",
        "offer_id": "665f1a2b3c4d5e6f70819201",
        "url_params": {"sub1": "sms"}
      },
      {
        "key": "link2",
        "offer_id": "665f1a2b3c4d5e6f70819204"
      }
    ]
  }'

import requests

response = requests.put(
    "https://api.tracklysms.com/api/v2/creatives/101",
    headers={
        "X-Api-Key": "trk_your_api_key_here",
        "Content-Type": "application/json"
    },
    json={
        "name": "Summer Sale Promo v2",
        "message": "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
        "offer_links": [
            {
                "key": "link1",
                "offer_id": "665f1a2b3c4d5e6f70819201",
                "url_params": {"sub1": "sms"}
            },
            {
                "key": "link2",
                "offer_id": "665f1a2b3c4d5e6f70819204"
            }
        ]
    }
)

data = response.json()
print(f"Updated: {data['name']}")
print(f"New segment count: {data['segment_count']}")

const response = await fetch(
  "https://api.tracklysms.com/api/v2/creatives/101",
  {
    method: "PUT",
    headers: {
      "X-Api-Key": "trk_your_api_key_here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Summer Sale Promo v2",
      message:
        "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
      offer_links: [
        {
          key: "link1",
          offer_id: "665f1a2b3c4d5e6f70819201",
          url_params: { sub1: "sms" },
        },
        {
          key: "link2",
          offer_id: "665f1a2b3c4d5e6f70819204",
        },
      ],
    }),
  }
);

const data = await response.json();
console.log(`Updated: ${data.name}`);

{
  "id": 101,
  "slug": "cre_summer-sale-promo-v2_a1b2c3",
  "name": "Summer Sale Promo v2",
    "message": "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
    "offer_links": [
      {
        "key": "link1",
        "offer_id": "665f1a2b3c4d5e6f70819201",
        "url": null,
        "url_params": {"sub1": "sms"}
      },
      {
        "key": "link2",
        "offer_id": "665f1a2b3c4d5e6f70819204",
        "url": null,
        "url_params": {}
      }
    ],
    "offers": ["665f1a2b3c4d5e6f70819201", "665f1a2b3c4d5e6f70819204"],
    "status": "active",
    "creative_type": "automated",
    "character_count": 151,
    "segment_count": 1,
    "created_at": "2025-06-10T12:00:00",
    "list_control_mode": "all",
    "list_control_ids": []
}

{
  "error": "Missing offer_links for placeholders: link2",
  "code": "missing_offer_links_for_placeholders"
}

{
  "error": "Creative not found",
  "code": "not_found"
}

{
  "error": "Invalid credentials",
  "code": "invalid_credentials"
}

PUT

creatives

{id}

curl -X PUT "https://api.tracklysms.com/api/v2/creatives/101" \
  -H "X-Api-Key: trk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer Sale Promo v2",
    "message": "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
    "offer_links": [
      {
        "key": "link1",
        "offer_id": "665f1a2b3c4d5e6f70819201",
        "url_params": {"sub1": "sms"}
      },
      {
        "key": "link2",
        "offer_id": "665f1a2b3c4d5e6f70819204"
      }
    ]
  }'

import requests

response = requests.put(
    "https://api.tracklysms.com/api/v2/creatives/101",
    headers={
        "X-Api-Key": "trk_your_api_key_here",
        "Content-Type": "application/json"
    },
    json={
        "name": "Summer Sale Promo v2",
        "message": "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
        "offer_links": [
            {
                "key": "link1",
                "offer_id": "665f1a2b3c4d5e6f70819201",
                "url_params": {"sub1": "sms"}
            },
            {
                "key": "link2",
                "offer_id": "665f1a2b3c4d5e6f70819204"
            }
        ]
    }
)

data = response.json()
print(f"Updated: {data['name']}")
print(f"New segment count: {data['segment_count']}")

const response = await fetch(
  "https://api.tracklysms.com/api/v2/creatives/101",
  {
    method: "PUT",
    headers: {
      "X-Api-Key": "trk_your_api_key_here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Summer Sale Promo v2",
      message:
        "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
      offer_links: [
        {
          key: "link1",
          offer_id: "665f1a2b3c4d5e6f70819201",
          url_params: { sub1: "sms" },
        },
        {
          key: "link2",
          offer_id: "665f1a2b3c4d5e6f70819204",
        },
      ],
    }),
  }
);

const data = await response.json();
console.log(`Updated: ${data.name}`);

{
  "id": 101,
  "slug": "cre_summer-sale-promo-v2_a1b2c3",
  "name": "Summer Sale Promo v2",
    "message": "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
    "offer_links": [
      {
        "key": "link1",
        "offer_id": "665f1a2b3c4d5e6f70819201",
        "url": null,
        "url_params": {"sub1": "sms"}
      },
      {
        "key": "link2",
        "offer_id": "665f1a2b3c4d5e6f70819204",
        "url": null,
        "url_params": {}
      }
    ],
    "offers": ["665f1a2b3c4d5e6f70819201", "665f1a2b3c4d5e6f70819204"],
    "status": "active",
    "creative_type": "automated",
    "character_count": 151,
    "segment_count": 1,
    "created_at": "2025-06-10T12:00:00",
    "list_control_mode": "all",
    "list_control_ids": []
}

{
  "error": "Missing offer_links for placeholders: link2",
  "code": "missing_offer_links_for_placeholders"
}

{
  "error": "Creative not found",
  "code": "not_found"
}

{
  "error": "Invalid credentials",
  "code": "invalid_credentials"
}

Updates an existing creative in your account. Fields such as name, status, creative_type, list_control_mode, and list_control_ids can be updated independently — omitted fields remain unchanged. message and offer_links are the exception: they are re-validated together from the request body alone, so to change either one you must send both in the same request. Sending only message (without offer_links) or only offer_links (without message) fails validation — the omitted field is treated as empty, not as its stored value. When both are sent, character_count and segment_count are automatically recalculated.

message and offer_links are validated as a pair from the request body only. Always send both together when changing either — sending one alone fails with missing_link_placeholder or missing_offer_links_for_placeholders, since the omitted field defaults to empty rather than falling back to the stored value.

Path Parameters

integer

required

The unique identifier of the creative to update.

Body Parameters

All body parameters are optional, except that message and offer_links must be sent together (see below). Only include the fields you want to change.

string

Updated display name. Maximum 255 characters.

string

Updated message template. Maximum 1600 characters. Must contain at least one {{linkN}} placeholder. Must be sent together with offer_links; sending message without offer_links fails, because offer_links is read from the request body alone (defaulting to empty) rather than from the stored value.

array

Updated array of offer link objects. Every {{linkN}} placeholder in the message must have a matching entry. Must be sent together with message; sending offer_links without message fails with missing_link_placeholder, because message is read from the request body alone (defaulting to empty) rather than from the stored value.

Show Offer link properties

string

required

The placeholder key (e.g. link1).

string

required

The ID of the offer to associate with this link. Must be a valid 24-character hexadecimal ObjectId, and the offer must exist and belong to your account.

string

Optional URL override.

object

Optional additional query parameters.

string

Updated status. Accepted values: active, paused, archived. Note that unlike creation, you can set the status to archived during an update.

string

Updated creative type. Accepted values: automated, one_time, welcome.

string

List targeting control mode. Accepted values: all, include, exclude.

array

List IDs (integers) to include or exclude when list_control_mode is include or exclude.

Response Fields

The response is the full updated creative object (flat, not wrapped).

Show Creative object properties

integer

Unique identifier for the creative.

string

Auto-generated unique identifier (e.g. cre_summer-sale-promo_a1b2c3).

string

Display name of the creative.

string

The message template with {{linkN}} placeholders.

array

Array of offer link objects.

array

Array of offer ID strings referenced by this creative.

string

Current status of the creative.

string

The type of creative.

integer

Estimated character count (recalculated if message or offer_links changed).

integer

Estimated SMS segment count (recalculated if message or offer_links changed).

datetime

ISO 8601 timestamp of when the creative was originally created.

string

List targeting control mode. One of: all (default), include, exclude.

array

List IDs used when list_control_mode is include or exclude.

Examples

curl -X PUT "https://api.tracklysms.com/api/v2/creatives/101" \
  -H "X-Api-Key: trk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer Sale Promo v2",
    "message": "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
    "offer_links": [
      {
        "key": "link1",
        "offer_id": "665f1a2b3c4d5e6f70819201",
        "url_params": {"sub1": "sms"}
      },
      {
        "key": "link2",
        "offer_id": "665f1a2b3c4d5e6f70819204"
      }
    ]
  }'

import requests

response = requests.put(
    "https://api.tracklysms.com/api/v2/creatives/101",
    headers={
        "X-Api-Key": "trk_your_api_key_here",
        "Content-Type": "application/json"
    },
    json={
        "name": "Summer Sale Promo v2",
        "message": "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
        "offer_links": [
            {
                "key": "link1",
                "offer_id": "665f1a2b3c4d5e6f70819201",
                "url_params": {"sub1": "sms"}
            },
            {
                "key": "link2",
                "offer_id": "665f1a2b3c4d5e6f70819204"
            }
        ]
    }
)

data = response.json()
print(f"Updated: {data['name']}")
print(f"New segment count: {data['segment_count']}")

const response = await fetch(
  "https://api.tracklysms.com/api/v2/creatives/101",
  {
    method: "PUT",
    headers: {
      "X-Api-Key": "trk_your_api_key_here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Summer Sale Promo v2",
      message:
        "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
      offer_links: [
        {
          key: "link1",
          offer_id: "665f1a2b3c4d5e6f70819201",
          url_params: { sub1: "sms" },
        },
        {
          key: "link2",
          offer_id: "665f1a2b3c4d5e6f70819204",
        },
      ],
    }),
  }
);

const data = await response.json();
console.log(`Updated: ${data.name}`);

{
  "id": 101,
  "slug": "cre_summer-sale-promo-v2_a1b2c3",
  "name": "Summer Sale Promo v2",
    "message": "Exclusive summer deals! Shop now: {{link1}} Browse more: {{link2}} Reply STOP to opt out.",
    "offer_links": [
      {
        "key": "link1",
        "offer_id": "665f1a2b3c4d5e6f70819201",
        "url": null,
        "url_params": {"sub1": "sms"}
      },
      {
        "key": "link2",
        "offer_id": "665f1a2b3c4d5e6f70819204",
        "url": null,
        "url_params": {}
      }
    ],
    "offers": ["665f1a2b3c4d5e6f70819201", "665f1a2b3c4d5e6f70819204"],
    "status": "active",
    "creative_type": "automated",
    "character_count": 151,
    "segment_count": 1,
    "created_at": "2025-06-10T12:00:00",
    "list_control_mode": "all",
    "list_control_ids": []
}

{
  "error": "Missing offer_links for placeholders: link2",
  "code": "missing_offer_links_for_placeholders"
}

{
  "error": "Creative not found",
  "code": "not_found"
}

{
  "error": "Invalid credentials",
  "code": "invalid_credentials"
}

Error Codes

HTTP Status	Error Code	Description
400	`name_too_long`	The `name` exceeds 255 characters.
400	`message_too_long`	The `message` exceeds 1600 characters.
400	`invalid_status`	The provided `status` is not `active`, `paused`, or `archived`.
400	`invalid_creative_type`	The provided `creative_type` is not `automated`, `one_time`, or `welcome`.
400	`invalid_list_control_mode`	The provided `list_control_mode` is not `all`, `include`, or `exclude`.
400	`invalid_list_control_ids`	`list_control_ids` is not a list of integers.
400	`missing_link_placeholder`	The updated message must contain at least one `{{linkN}}` placeholder.
400	`missing_offer_links_for_placeholders`	One or more `{{linkN}}` placeholders in the message do not have a matching entry in `offer_links`.
400	`missing_offer_link_key`	An entry in `offer_links` is missing the required `key` field.
400	`missing_offer_link_offer_id`	An entry in `offer_links` is missing the required `offer_id` field.
400	`invalid_offer_link_offer_id`	An `offer_id` in `offer_links` is not a valid 24-character hexadecimal ObjectId.
401	`invalid_credentials`	API key is missing or invalid.
403	`account_suspended`	Your account is suspended. Resolve outstanding billing or contact support.
429	`rate_limited`	Request throttled; retry with exponential backoff after the window resets.
404	`not_found`	No creative exists with the given ID.
400	`offer_not_found`	An offer referenced in `offer_links` does not exist or does not belong to your account.

API Reference

V2 API Reference

Partner Accounts (v2)

Messages (v2)

Contacts (v2)

Lists (v2)

Number Requests (v2)

Business Profiles (v2)

Creatives (v2)

Audiences (v2)

Offers (v2)

Schedules (v2)

Revenue (v2)

Usage & Billing (v2)

Data Import (v2)

Links (v2)

Clicks (v2)

Webhooks (v2)

Phone Validation (v1)

API Reference (v1 - Deprecated)

Path Parameters

Body Parameters

Response Fields

Examples

Error Codes

Next Steps

Creative Templates

Create Schedule

​Path Parameters

​Body Parameters

​Response Fields

​Examples

​Error Codes

​Next Steps

Creative Templates

Create Schedule

Path Parameters

Body Parameters

Response Fields

Examples

Error Codes

Next Steps