Referencia API

Create Client

post
https://connect.agendapro.com/v3/clients

This endpoint creates a new client for the company.

Important Notes

  • At least one of last_name, email, or phone is required by business logic.
  • Email is normalized to lowercase.
  • Phone must follow E.164 format.

Errors Dictionary

StatusErrorDetailDescription
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks clients:write scope.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 255

Client first name.

string
length ≤ 255

Client last name.

string
length ≤ 255

Client email.

string
length ≤ 255

National identification number.

string
length ≤ 255

Phone number in E.164 format.

string
length ≤ 255

Street address.

string
length ≤ 255

District or neighborhood.

string
length ≤ 255

City.

string
length ≤ 255

Region or state.

integer
≥ 1

Client age.

integer
enum

Gender: 0 = other, 1 = female, 2 = male.

Allowed:
integer
≥ 1

Day of birth.

integer
≥ 1

Month of birth.

integer
≥ 1

Year of birth.

custom_attributes
array of objects

Custom attribute values to set.

custom_attributes
Responses

Updated 27 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago