Update a Contact

Update fields on an existing contact. Only send the fields you want to change. Permission: contacts:update

PUT /api/contacts/{clientId}

Update a contact

cURL

curl --request PUT \
  --url https://api.recepta.ai/api/v1/api/contacts/{clientId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "tags": [
    "<string>"
  ],
  "status": "<string>",
  "notes": "<string>",
  "customFields": {}
}
'

import requests

url = "https://api.recepta.ai/api/v1/api/contacts/{clientId}"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "tags": ["<string>"],
    "status": "<string>",
    "notes": "<string>",
    "customFields": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: '<string>',
    phone: '<string>',
    tags: ['<string>'],
    status: '<string>',
    notes: '<string>',
    customFields: {}
  })
};

fetch('https://api.recepta.ai/api/v1/api/contacts/{clientId}', 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://api.recepta.ai/api/v1/api/contacts/{clientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '<string>',
    'phone' => '<string>',
    'tags' => [
        '<string>'
    ],
    'status' => '<string>',
    'notes' => '<string>',
    'customFields' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.recepta.ai/api/v1/api/contacts/{clientId}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"customFields\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.recepta.ai/api/v1/api/contacts/{clientId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"customFields\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recepta.ai/api/v1/api/contacts/{clientId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"customFields\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "data": {
    "client": {
      "id": "697929d5ebccbcca5cdaf13b",
      "firstName": "Jane",
      "lastName": "Doe",
      "fullName": "Jane Doe",
      "email": "[e-mail]",
      "phone": "[phone]",
      "source": "API",
      "tags": [
        "lead",
        "website"
      ],
      "status": "active",
      "notes": "Interested in premium plan",
      "company_name": "Acme Corp",
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "customFields": {
        "referralSource": "google"
      },
      "isActive": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  }
}

{
  "success": false,
  "message": "Error description"
}

Authorizations

x-api-key · string · header · required

Your Recepta API key (starts with rcp_)

Path Parameters

clientId · string · required

Contact ID

Body

application/json

firstName · string

lastName · string

email · string

phone · string

tags · string[]

status · string

notes · string

customFields · object

Response

200

application/json

Contact updated

success · boolean

Example:

true

data · object

Show child attributes