Update a contact

PUT

/contact/{identifier}

curl --request PUT \
  --url https://api.aelyst.ai/v1/contact/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "firstName": "Muhammad ", "lastName": "Mahin", "phone": "+60123456789", "email": "test@example.com", "language": "ms", "profilePic": "https://cdn.aelyst.ai/profile_avatar.png", "countryCode": "MY", "custom_fields": [ { "name": "Company Website", "value": "https://example.com" } ] }'

• Production

Updates an existing contact. Only the contact fields that are included in the body will be updated. The first contact will be updated when duplicate contacts with the defined identifier exist.

Authorizations

• BearerAuth

Parameters

Path Parameters

identifier

required

string

Identifier of the contact that can either be a phone number, email or contact ID. Examples: id:123 , email:abdc@gmail.com , phone:+60121233112

Request Body

Media typeapplication/json

Any of:

object

object

firstName

required

string

Example

Muhammad

lastName

string

nullable

Example

Mahin

phone

string

nullable

Example

+60123456789

email

string

nullable

Example

test@example.com

language

Following the ISO 639-1 standard.

string

nullable

Example

ms

profilePic

string

nullable

Example

https://cdn.aelyst.ai/profile_avatar.png

countryCode

Following the ISO 3166-1 alpha-2 standard.

string

nullable

Example

MY

custom_fields

Array<object>

nullable

object

name

required

string

Example

Company Website

value

Formatting rules

• Text: “string” (use quotation marks for the string value)
• Number: Number (without any quotation marks)
• Email: “email” (format: user@domain.com)
• URL: “url” (format: www.website.com, https://www.website.com, website.com, http://website.com)
• List: “string” (the string value must match one of the list options)
• Date: “yyyy-mm-dd” (must follow this format)
• Time: “HH:MM” (must follow 24H format, 1PM => 13:00)
• Checkbox: “true/false” (must be true for checked, false for unchecked)

string

nullable

Example

https://example.com

Responses

200

Media typeapplication/json

object

contactId

ID of the contact on which the action was performed.

integer

Example^generated

{
  "contactId": 1
}

400

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 400,
  "message": "Validation error."
}

401

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 401,
  "message": "UN_AUTHORIZED"
}

429

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 429,
  "message": "Too Many Requests"
}

Headers

Retry-After

number

Example

1

Number of seconds until you can retry the request

X-RateLimit-Limit

number

Example

10

Number of request allowed for this end point

X-RateLimit-Remaining

number

Example

5

Number of request remaining for this end point

449

object

code

integer

message

string

Example

{
  "code": 449,
  "message": "Your request cannot be processed at the moment as it is currently in queue. Please try again in a few minutes."
}

object

code

integer

Example

449

message

string

Example

Your request cannot be processed at the moment as it is currently in queue. Please try again in a few minutes.

object

code

integer

Example

449

message

string

Example

Your request cannot be processed at the moment as it is currently in queue. Please try again in a few minutes.

500

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 500,
  "message": "Unexpected error occurred"
}