Send an SMS

• Authorizationstringheaderrequired

  Your secret key as a bearer token, in the form Bearer ks_live_sk_... or Bearer ks_test_sk_.... Keep it on your server. A test key gets the documented example and touches no school data.

• idempotency-keystringheaderrequired

  A key of your own that makes this write safe to retry: the same key returns the first response instead of writing again.

application/json

• messagestring

• recipientsobject

  Show child attributesHide child attributes

  • studentIdsinteger[]

  • guardianIdsinteger[]

200, application/json

• dataobjectrequired

  Show child attributesHide child attributes

  • idnumberrequired

  • statusstringrequired

  • pagesnumberrequired

    SMS pages per recipient.

  • recipientCountnumberrequired

    Recipients the message was accepted for.

  • skippedCountnumber or nullrequired

    Recipients named but not sent to (no number on record, or a suppressed number). Null on a status read.

  • chargenumberrequired

    The in-app SMS charge held on the SERVICE wallet, in major units.

  • currencystringrequired

  • pendingCountnumberrequired

  • sentCountnumberrequired

  • deliveredCountnumberrequired

  • failedCountnumberrequired

  • failureReasonstring or nullrequired

  • createdOnstringrequired

• metaobjectrequired

  Show child attributesHide child attributes

  • request_idstringrequired

    Also returned in the X-Request-ID header.

  • paginationobject

    Show child attributesHide child attributes

    • limitintegerrequired

      Required range: x <= 100

    • has_morebooleanrequired

    • next_cursorstring or nullrequired

      Send this back as cursor for the next page. Opaque: never parse it.

• 400invalid_parameterA request parameter is invalid; `field` names it. A write sent without an Idempotency-Key is refused this way with `field` set to `Idempotency-Key`.
• 401invalid_api_keyNo key was presented, or the key is not valid.
• 402insufficient_balanceThe school's service wallet cannot cover this call.
• 403insufficient_scopeThe app does not hold the scope this endpoint needs.
• 404endpoint_not_exposedThis endpoint is not part of the API.
• 422channel_unavailableThe school cannot send on this channel right now. Nothing was sent to anyone.
• 429rate_limitedThe rate limit was reached. Retry after the Retry-After header says.
• 503platform_unavailableThe API is not available for this school right now.

What each code means, and what to do about it, is in the errors guide.

This call triggers no webhook event.