Forget the phone number linked to a user_id

Removes the user_id to phone link that a tracked event carrying both taught us (see POST /v1/track).

DELETE/v1/automations/identities/{user_id}

Path Parameters

user_idstringrequired
Your own id for the person, as passed to POST /v1/track. At most 128 characters.

Details

Later events with only that user_id start nothing until a call with both links them again. Runs, tracked events and consent records are not changed.

Audit-logged as automation.identity_unlinked. Use it to honour a deletion request for one person.

Responses

200JSON object
Unlinked
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429Error
Rate limit or quota exceeded

Response Fields

objectautomation_identityrequired
user_idstringrequired
unlinkedtruerequired

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429
Rate limit or quota exceeded

const res = await fetch('https://api.jointextkit.com/v1/automations/identities/USER_ID', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Response 200

{
  "object": "automation_identity",
  "user_id": "string",
  "unlinked": true
}