Update contact lifecycle

POST

/contact/{identifier}/lifecycle/update

curl --request POST \
  --url https://api.aelyst.ai/v1/contact/example/lifecycle/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

• Production

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

object

name

required

Updating lifecycle stage to empty value will remove lifecycle stage from a contact

string

nullable

Example^generated

{
  "name": "example"
}

Responses

200

Media typeapplication/json

object

code

number

message

string

default: Contact lifecycle stage updated successfully!

Example

{
  "code": 200,
  "message": "Contact lifecycle stage updated successfully!"
}

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

500

Media typeapplication/json

object

code

integer

message

string

Example

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