integration_apps.apps.update

Replace an integration app's facts and return addresses; answers the app and `outcome`: saved (at once, while testing or sent back), proposed (approved: the reviewed facts wait for Tawked's team, the approved ones keep working), cancelled (the change that waited was dropped) or unchanged.

curl --request PUT \
  --url https://tawked.com/v1/integration-apps/{app} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name_ar=<string>' \
  --form 'name_en=<string>' \
  --form 'redirect_uris=<string>' \
  --form 'site_url=<string>' \
  --form 'connect_url=<string>' \
  --form 'description=<string>' \
  --form 'logo=<string>' \
  --form remove_logo=true

const form = new FormData();
form.append('name_ar', '<string>');
form.append('name_en', '<string>');
form.append('redirect_uris', '<string>');
form.append('site_url', '<string>');
form.append('connect_url', '<string>');
form.append('description', '<string>');
form.append('logo', '<string>');
form.append('remove_logo', 'true');

const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://tawked.com/v1/integration-apps/{app}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tawked.com/v1/integration-apps/{app}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name_ar\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name_en\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirect_uris\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"site_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"connect_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"remove_logo\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://tawked.com/v1/integration-apps/{app}"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name_ar\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name_en\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirect_uris\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"site_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"connect_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"remove_logo\"\r\n\r\ntrue\r\n-----011000010111000001101001--"
headers = {"Authorization": "Bearer <token>"}

response = requests.put(url, data=payload, headers=headers)

print(response.text)

{
  "data": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

PUT

integration-apps

{app}

curl --request PUT \
  --url https://tawked.com/v1/integration-apps/{app} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name_ar=<string>' \
  --form 'name_en=<string>' \
  --form 'redirect_uris=<string>' \
  --form 'site_url=<string>' \
  --form 'connect_url=<string>' \
  --form 'description=<string>' \
  --form 'logo=<string>' \
  --form remove_logo=true

const form = new FormData();
form.append('name_ar', '<string>');
form.append('name_en', '<string>');
form.append('redirect_uris', '<string>');
form.append('site_url', '<string>');
form.append('connect_url', '<string>');
form.append('description', '<string>');
form.append('logo', '<string>');
form.append('remove_logo', 'true');

const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://tawked.com/v1/integration-apps/{app}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tawked.com/v1/integration-apps/{app}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name_ar\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name_en\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirect_uris\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"site_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"connect_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"remove_logo\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://tawked.com/v1/integration-apps/{app}"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name_ar\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name_en\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirect_uris\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"site_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"connect_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"remove_logo\"\r\n\r\ntrue\r\n-----011000010111000001101001--"
headers = {"Authorization": "Bearer <token>"}

response = requests.put(url, data=payload, headers=headers)

print(response.text)

{
  "data": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

An account token from Settings › Account API in the Tawked console: Authorization: Bearer tk_acct_…

Headers

Idempotency-Key

string

One per intended change (1 to 128 printable ASCII characters): a retry with the same key and the same request answers the stored 2xx with Idempotent-Replayed: true, for 24 hours. A 428 approval_required is never stored: send the approved request again with the same key or none. An answer that carried a secret shown once is never kept: its replay answers 409 idempotency_secret_not_replayable with the id of what it made.

Required string length: 1 - 128

Path Parameters

app

string

required

The id of an integration app this account makes (a UUID); list them with integration_apps.apps.list.

Pattern: ^(?:[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})$

Body

multipart/form-data

name_ar

string

required

Required string length: 2 - 40

name_en

string

required

Required string length: 2 - 40

redirect_uris

string[]

required

Required array length: 1 - 5 elements

Maximum string length: 500

site_url

string<uri>

required

Maximum string length: 255

connect_url

string | null

Maximum string length: 2048

description

string | null

Maximum string length: 1000

logo

file | null

Maximum string length: 256

remove_logo

boolean

Response

Done.

data

object

required