raims customers

Create or update a customer by tax ID.

POST /v1/customers

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  city                string  optional, nullable
  complement          string  optional, nullable
  dial_code           string  optional, nullable
  email               string  optional, nullable
  external_reference  string  optional, nullable
  full_name           string  optional, nullable
  metadata            object  optional, nullable
  neigh               string  optional, nullable
  phone_local         string  optional, nullable
  street              string  optional, nullable
  street_number       string  optional, nullable
  tax_id              string  required
  uf                  string  optional, nullable
  zip_code            string  optional, nullable
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "full_name": "Cliente de teste",
  "tax_id": "12345678909",
  "email": "cliente@example.invalid",
  "dial_code": "55",
  "phone_local": "11987654321",
  "zip_code": "01310000",
  "street": "Avenida de exemplo",
  "street_number": "100",
  "complement": "Sala 1",
  "neigh": "Centro",
  "city": "São Paulo",
  "uf": "SP"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Metadata options send a text map: repeat --metadata KEY=VALUE for values, use --metadata-null KEY for a null value, or --metadata-empty for an empty object. Empty text, numeric-looking values and the text null remain strings. Omitted metadata and an empty object preserve existing keys when updating; null values remove individual keys, and --body-null metadata clears the entire map. Do not combine these options with --data-file, or use multiple values for the same key.

Delete a customer.

DELETE /v1/customers/{id}

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Delete the customers listed in the request body.

DELETE /v1/customers

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  identifiers  array<string | null>  required
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "identifiers": [
    "cus_3AbHiWSrsZBoaTg47OcMzC",
    "cus_1szWVIyZES2MJoAMUmjwW"
  ]
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Get a customer.

GET /v1/customers/{id}

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

List customers.

GET /v1/customers

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Update a customer.

PATCH /v1/customers/{id}

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  city                string  optional, nullable
  complement          string  optional, nullable
  dial_code           string  optional, nullable
  email               string  optional, nullable
  external_reference  string  optional, nullable
  full_name           string  optional, nullable
  metadata            object  optional, nullable
  neigh               string  optional, nullable
  phone_local         string  optional, nullable
  street              string  optional, nullable
  street_number       string  optional, nullable
  uf                  string  optional, nullable
  zip_code            string  optional, nullable
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "full_name": "Cliente atualizado",
  "email": "atualizado@example.invalid"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Metadata options send a text map: repeat --metadata KEY=VALUE for values, use --metadata-null KEY for a null value, or --metadata-empty for an empty object. Empty text, numeric-looking values and the text null remain strings. Omitted metadata and an empty object preserve existing keys when updating; null values remove individual keys, and --body-null metadata clears the entire map. Do not combine these options with --data-file, or use multiple values for the same key.