API & Developers

    Keys, endpoints, scheduling and the activity log.

    5 answers

    Create an API key

    Keys are per company and are shown once, at creation.

    Generate a key from the API Keys page and store it in your own secret manager. Revoke and reissue any time, revocation takes effect immediately.

    Give each integration its own key so you can revoke one without breaking the others.

    What the API can do

    Contacts, custom fields, templates and template sends.

    The external API covers contact create and update including custom fields, listing your approved templates, and sending a template message to a number.

    It is deliberately narrow: it does the things other systems need, without exposing the inbox.

    Schedule a send through the API

    Queue a single template message up to 20 days ahead.

    Pass a future timestamp and the message is queued rather than sent. It appears on the Scheduled Messages page and can be cancelled there like any other scheduled send.

    API-scheduled sends are tagged separately from campaigns in reporting, so you can tell system traffic from marketing traffic.

    See every API call

    An activity log of calls, keys, payload status and errors.

    Each call is logged with the key used, the endpoint, the result and the error where there was one. It is the first place to look when a vendor says "we sent it".

    The log lives alongside the API Keys page in the app.

    Common API responses

    401 means the key, 402 means the account, 400 means the payload.

    401 is a missing, wrong or revoked key. 402 means the subscription has ended or a required balance is empty: the account, not the request, needs attention. 400 is usually an unapproved template name or a badly formatted number.

    Numbers must include the country code with no plus sign.

    Did not find your answer here?

    Tell us the number, the time and what you expected. That is usually enough for us to spot it.