Update an Agent

put

https://rcs-api.in.kaleyra.io/v1/{sid}/rcs/agent/{agent_number}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Update an AgentAPI allows you to update the agent that has been created by the end-user.

Prerequisites

After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in kaleyra.io.
Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
To send any RCS messages, you must configure the RCS channel in the Kaleyra platform. To configure the RCS channel in your account, please contact your local Kaleyra representative.

Path Params

agent_number

string

required

Auto-generated number assigned by the server at the time
of the Create Agent request.

Body Params

string

Agent identification number.

agent_type

string

enum

Business messaging agent type.

Allowed:

logo_url

uri

Logo image URL.

hero_url

uri

Public hero image URL.
Cannot be modified after verification.

default_locale

string

Default locale.

agent_test_url

uri

Agent test URL.

end_point_config

string

Endpoint configuration.

primary_interaction_type

string

Primary interaction type.

agent_number

string

Auto-generated agent number.

provider_agent_id

string

Provider-generated agent ID.

service_code

string

length ≥ 1

Unique service identifier.

description

string

length ≤ 100

Agent description.

phones

array of objects

length ≤ 3

phones

emails

array of objects

length ≤ 3

emails

privacy

object

terms_conditions

object

color

string

Primary brand color.

billing_category

string

Billing category.

agent_use_case

string

enum

Agent use case.

Allowed:

hosting_region

string

enum

Hosting region.

Allowed:

status

string

Agent status.

rcs_provider_id

integer

RCS provider identifier.

verification_name

string

Verification name.

verification_state

string

Verification state.

integration_status

boolean

Integration status.

integration_name

string

Integration name.

website

array of objects

length ≤ 3

website

brand_details

object

display_name

string

length between 1 and 40

Agent display name.

Headers

api-key

string

required

API key generated from the Kaleyra account.

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Prerequisites

200Agent updated successfully.

400Validation failed.

401Incorrect SID or API key.

405Method not allowed.

500Internal server error.