FireFlo OMNI

Changes a contact. Only what the body gives changes. Fields given are set and the rest kept; a field set to null is cleared. Tags given replace theirs. A new phone becomes their main number and the old one stays among their identifiers, so they are still found by it.

Needs the contacts:write scope.

Path parameters

Field	Type	Required	Notes
`contact_id`	string	Yes	The contact’s id.

Body

Field	Type	Required	Notes
`phone`	string	No	With its country code: `+919876543210`. A number without one is read in your account’s country.
`name`	string	No	Up to 200 characters.
`fields`	object	No	Values by contact field key, checked against each field’s type. Fields not named are kept; null clears one.
`tags`	array	No	Up to 50 tag names (each up to 60 characters). Replaces their tags; `[]` removes them all. A tag the account doesn’t have yet is made.
`timezone`	string	No	A time zone name like `Asia/Kolkata`; empty or null clears it.
`quiet_hours`	object	No	`{"start": "21:00", "end": "08:00"}` (HH:MM, not the same time), or null to clear.

Request

curl -X PATCH https://api.fireflo.au/v1/contacts/3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42 \
  -H "Authorization: Bearer $OMNI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+919812345678",
    "fields": {
      "loyalty_tier": "platinum",
      "city": null
    }
  }'

import os

import requests

response = requests.patch(
    "https://api.fireflo.au/v1/contacts/3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
    headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
    json={
        "phone": "+919812345678",
        "fields": {
            "loyalty_tier": "platinum",
            "city": None,
        },
    },
)
print(response.status_code, response.json())

const response = await fetch("https://api.fireflo.au/v1/contacts/3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "phone": "+919812345678",
    "fields": {
      "loyalty_tier": "platinum",
      "city": null
    }
  }),
});
console.log(response.status, await response.json());

Response

200 OK

{
  "id": "3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
  "name": "Asha Rao",
  "phone": "+919812345678",
  "identifiers": [
    {
      "kind": "phone",
      "value": "+919812345678",
      "primary": true
    },
    {
      "kind": "phone",
      "value": "+919876543210",
      "primary": false
    },
    {
      "kind": "email",
      "value": "asha@acme.in",
      "primary": false
    }
  ],
  "fields": {
    "loyalty_tier": "platinum"
  },
  "tags": [
    "newsletter",
    "vip"
  ],
  "consent": {
    "do_not_contact": false,
    "reason": "",
    "until": null,
    "opted_out_at": null
  },
  "timezone": "Asia/Kolkata",
  "quiet_hours": {
    "start": "21:00:00",
    "end": "08:00:00"
  },
  "created": "2026-08-14T05:21:09.338Z",
  "updated": "2026-10-05T09:14:22.413Z"
}

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault.

Status	Error code	When
404	`not_found`	No contact has that id on this account.
400	`invalid_request`	An input is wrong: a number that isn’t valid, a field value of the wrong type, a bad time zone or quiet hours (`field` names it).
409	`contact_exists`	Another contact already has that number; the message names that contact’s id.
400	`invalid_json`	The body isn’t valid JSON.
403	`scope_missing`	The key doesn’t have the `contacts:write` scope.

Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.

Overview

Account

Messages

Routes

Templates

Contacts

Conversations

Senders

Calls

Usage

Webhooks

WhatsApp

SMS

Try it

PATCH /v1/contacts/{contact_id}

Path parameters

Body

Request

Response

Errors

​Path parameters

​Body

​Request

​Response

​Errors

Path parameters

Body

Request

Response

Errors