For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create a To Do

Create a To Do

post

Create a new To Do. The body is flat (no to_do wrapper) and always carries account_number, delivery_type, and a schedule object. The remaining required fields depend on the channel:

  • smsfrom, contact, message_text

  • emailcontact, message_text, from_email

  • callinstructions

  • ai_outbound_callcontact, instructions

In schedule, set rule to immediately to send once right away, or to today to send once today at each entry in times. Omit rule to create a recurring To Do driven by frequency, times, interval, and days.

Authorizations
AuthorizationstringRequired

Answering Service Care uses bearer token authentication. Generate API tokens from your user profile under Application Keys.

Body

Flat create payload — there is no to_do wrapper. account_number, delivery_type, and schedule are always required; every other field is required per channel.

account_numberstringRequired

Account number of the DID the To Do runs against. The authenticated user must be an admin or a member of that account.

Example: W0411
delivery_typestring · enumRequired

Delivery channel, matched case-insensitively. ai_outbound_call places an AI-handled outbound call and requires a Telnyx AI Assistant attached to the account's number; it is not yet released to production.

Example: ai_outbound_callPossible values:
namestringOptional

Label for the To Do. Defaults to the creation timestamp when omitted.

Example: Appointment confirmation
contactstringOptional

Recipient — phone number for sms and ai_outbound_call, email address for email. Required for those three channels.

Example: +15555550100
message_textstringOptional

Message body. Required for sms and email.

instructionsstringOptional

What the agent or AI assistant should say. Required for call and ai_outbound_call.

fromstringOptional

Sending number for sms. Required, and validated against the account's SMS-enabled numbers; a leading +1 is stripped.

Example: 5555550100
from_emailstringOptional

Sending address for email. Required, must not be blacklisted, and its domain must be an authenticated SendGrid domain on the account.

Example: reception@example.com
sender_namestringOptional

Optional display name for email.

subjectstringOptional

Optional subject line for email.

Responses
200

Successful response

application/json
post/api/v2/to-dos
POST /api/v2/to-dos HTTP/1.1
Host: secure.answeringservicecare.com
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 277

{
  "account_number": "W0411",
  "delivery_type": "ai_outbound_call",
  "contact": "+15555550100",
  "instructions": "Call the customer to confirm tomorrow's 10 AM service window. If they cannot make it, offer 2 PM instead.",
  "name": "Appointment confirmation",
  "schedule": {
    "rule": "immediately"
  }
}
{
  "data": {
    "id": 157,
    "name": "text",
    "phone_id": 1,
    "delivery_type": "sms",
    "contact": "text",
    "message_text": "text",
    "instructions": "text",
    "from": "text",
    "from_email": "text",
    "sender_name": "text",
    "subject": "text",
    "sendgrid_authenticated_domain_id": 1,
    "ai_assistant_id": "text",
    "times": [
      "text"
    ],
    "is_sending": true,
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "schedule": {
      "id": 1,
      "schedulable_id": 1,
      "schedulable_type": "ToDo",
      "rule": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "times": [
        "text"
      ],
      "previous_occurrence": "2026-01-01T00:00:00.000Z",
      "next_occurrence": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  }
}

Last updated

Was this helpful?