Update client - HT Partner API

Request

Authorization

Add parameter in header

Api-Key

Example:

Api-Key: ********************

Path Params

id

string

required

Body Params application/json

external_id

string | null

optional

The external ID of the client.

first_name

string | null

optional

The first name of the client.

last_name

string | null

optional

The last name of the client.

email

string <email>

required

The email address of the client.

full_address

string | null

optional

The full address of the client, including street, city, state, and zip code.

phone

string | null

optional

The phone number of the client.

Example

{
    "external_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "full_address": "string",
    "phone": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://apis.hellotech.com/api/partners/clients/' \
--header 'Content-Type: application/json' \
--header 'Api-Key;' \
--data-raw '{
    "external_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "full_address": "string",
    "phone": "string"
}'

Responses

🟢200Client created successfully

application/json

Body

id

integer

optional

The unique identifier of the client.

external_id

string

optional

The external unique identifier of the client.

first_name

string

optional

The first name of the client.

last_name

string

optional

The last name of the client.

email

string <email>

optional

The email address of the client.

phone

string

optional

The phone number of the client.

full_address

string

optional

The full address of the client.

address

object

optional

city

string

optional

The city of the client's address.

state

string

optional

The state of the client's address.

zip

string

optional

The zip code of the client's address.

street

string

optional

The street address of the client.

authentication_token

string

required

Example

{
    "id": 0,
    "external_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "phone": "string",
    "full_address": "string",
    "address": {
        "city": "string",
        "state": "string",
        "zip": "string",
        "street": "string"
    },
    "authentication_token": "string"
}

🟠400Error response

🟠404Error response