Skip to content
Athenty Athenty Resources

Create a client record

POST
/clients

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
nameFirst
string
<= 64 characters
nameLast
string
<= 64 characters
businessName
string
<= 128 characters
email
string format: email
<= 255 characters
phone
string
<= 32 characters
externalId

Your internal system identifier for this client

string
<= 64 characters
memberType
string
default: individual
Allowed values: individual business
addressLine1
string
<= 128 characters
addressLine2
string
<= 128 characters
city
string
<= 64 characters
region

Province or state

string
<= 64 characters
postalCode
string
<= 16 characters
country

ISO 3166-1 alpha-2 country code

string
default: CA >= 2 characters <= 2 characters
metadata

Arbitrary key-value data for your reference

object
key
additional properties
any
Examples

Individual client

{
  "nameFirst": "Jane",
  "nameLast": "Smith",
  "email": "jane@example.com",
  "memberType": "individual",
  "country": "CA"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Client created

object
id
string
orgId
string
nameFirst
string
nullable
nameLast
string
nullable
businessName
string
nullable
email
string
nullable
phone
string
nullable
externalId
string
nullable
memberType
string
Allowed values: individual business
addressLine1
string
nullable
addressLine2
string
nullable
city
string
nullable
region
string
nullable
postalCode
string
nullable
country
string
nullable
metadata
object
active
boolean
requestCount
integer
createdAt
string format: date-time
updatedAt
string format: date-time

401

Section titled “401 ”

Missing or invalid API key

object
code
string
message
string
statusCode
integer
Example
{
  "code": "UNAUTHORIZED",
  "message": "Invalid API key.",
  "statusCode": 401
}

422

Section titled “422 ”

Request body failed validation

object
code
string
message
string
statusCode
integer
errors
Array<object>
object
field
string
message
string
Example
{
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "statusCode": 422,
  "errors": [
    {
      "field": "type",
      "message": "Required"
    },
    {
      "field": "requirements",
      "message": "Array must contain at least 1 element(s)"
    }
  ]
}

429

Section titled “429 ”

Too many requests

object
code
string
message
string
statusCode
integer
Example
{
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "statusCode": 429
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the rate limit window resets

X-RateLimit-Limit
integer
X-RateLimit-Remaining
integer