Contacts API

Contacts API A contact is a single person you message — their name, phone number, email, channel, tags, custom fields, and the lists and campaigns they belong to. The Contacts API lets you create contacts, look them up, update them, tag them, import them in bulk, and remove them, all without using the dashboard. All paths on this page are relative to the base URL: https://api.relaytiv.com/v1 So /contacts means https://api.relaytiv.com/v1/contacts . New to the API? Read API Access first — it covers how to generate your API key, the three ways to authenticate, rate limits, and the error format. Everything on this page assumes you already have a working API key. About contact IDs Every contact has a unique ID. The ID you get back when you create a contact (in data.contactId ) is the same ID you use everywhere else — to fetch, update, tag, send a message, or delete that contact. Save it once and reuse it. You don't have to create a contact to get its ID. You can also look one up by phone number or email (see Get a contact ), or page through all your contacts (see List contacts ). Each of those returns the same ID. Create a contact POST /contacts Adds a new contact to your account. A phone number with country code is required — an email alone is not enough. Everything else is optional. You can optionally drop the new contact straight into one or more lists with listId (a single list) or listIds (an array). If both are sent, listIds wins. Any field you send that isn't a standard fi