POST   customers

Creates customer.

Remarks

Returns HTTP 201 when created (the Location header must contain URL to the new customer).

Request example and description

curl --request POST "https://api-asm1.apica.io/v3/customers?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E" --header "Content-Type: application/json" --data-raw "{
  \"name\": \"Apica\",
  \"contact_email\": \"support@apica.io\",
  \"country_code\": \"SE\",
  \"enabled\": true,
  \"subscription\": {
    \"subscription_type\": \"Standard\",
    \"period_from_utc\": \"2024-05-19T08:54:49\",
    \"period_to_utc\": \"2024-05-19T08:54:49\",
    \"global_check_quota\": 1000,
    \"alert_sms_quota\": 10000,
    \"alert_email_quota\": 1,
    \"enabled\": true
  }
}"
NameType Required Description
name String Yes

Customer name.
contact_email String Yes

Customer contact email.
country_code String No

Customer country code.
enabled Boolean No

Customer is enabled.
subscription Object No

Customer subscription data.
subscription_type String No

The customer's subscription type. Available values: 'Standard', 'PoC', 'Evaluation', 'Trial'
period_from_utc DateTime Yes

Subscription start period.
period_to_utc DateTime Yes

Subscription end period.
global_check_quota Integer Yes

The checks quota.
alert_sms_quota Integer Yes

SMS alerts quota.
alert_email_quota Integer Yes

SMS alerts quota is enabled.
enabled Boolean No

Subscription is enabled.