Update an integration

Rename it, pause or resume it (status), or change its settings or credentials (credentials left out keep the stored ones).

PATCH/v1/integrations/{id}

Path Parameters

idstringrequired
Example: int_a1B2c3D4e5F6.

Body Parameters

namestring
statusactive, paused
sourceIdstring
phoneFieldstring
phoneEventstring
phoneEventPropertystring
consentFieldstring
consentEventstring
usernamestring
secretstring
apiKeystring
secretKeystring
accessTokenstring

Details

Scope: contacts.

Responses

200JSON object
The integration
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

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/integrations/int_a1B2c3D4e5F6', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});

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

Response 200

{}