raims customers | Raims Documentation

Look up syntax, arguments, and options for each command. Use raims COMMAND --help to read the help in your terminal.

`raims customers`

Manage customers

Shell

raims customers [flags]

--help, -h bool default: false
- help for customers

Subcommands: raims customers create, raims customers delete, raims customers delete-batch, raims customers get, raims customers list, raims customers update.

`raims customers create`

Create or update a customer by tax ID

Shell

raims customers create [flags]

--body-null stringArray default: []
- Set a nullable JSON body field to null by its JSON name (repeat for each field; cannot be combined with --data-file)
--city string default: empty
- Set JSON body field city (string, nullable)
--complement string default: empty
- Set JSON body field complement (string, nullable)
--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dial-code string default: empty
- Set JSON body field dial_code (string, nullable)
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--email string default: empty
- Set JSON body field email (string, nullable)
--external-reference string default: empty
- Set JSON body field external_reference (string, nullable)
--full-name string default: empty
- Set JSON body field full_name (string, nullable)
--help, -h bool default: false
- help for create
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--metadata stringArray default: empty
- Set a metadata text value as KEY=VALUE (repeat for each key; dots in keys are literal)
--metadata-empty bool default: false
- Send an empty metadata object; an update preserves existing keys
--metadata-null stringArray default: []
- Send null for a metadata key (repeat for each key; removes it when updating)
--neigh string default: empty
- Set JSON body field neigh (string, nullable)
--phone-local string default: empty
- Set JSON body field phone_local (string, nullable)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--street string default: empty
- Set JSON body field street (string, nullable)
--street-number string default: empty
- Set JSON body field street_number (string, nullable)
--tax-id string default: empty
- Set JSON body field tax_id (string, required in the body)
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)
--uf string default: empty
- Set JSON body field uf (string, nullable)
--zip-code string default: empty
- Set JSON body field zip_code (string, nullable)

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.

Command example

Shell

raims --profile PROFILE --output json customers create --data-file request.json --dry-run
raims customers create --tax-id="12345678909" --dry-run

`raims customers delete`

Delete a customer

Shell

raims customers delete ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for delete
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json customers delete ID --dry-run

`raims customers delete-batch`

Delete the customers listed in the request body

Shell

raims customers delete-batch [flags]

--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for delete-batch
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--identifiers stringArray default: empty
- Set JSON body field identifiers (array<string>, repeat the option for each item, required in the body)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json customers delete-batch --data-file request.json --dry-run
raims customers delete-batch --identifiers="cus_3AbHiWSrsZBoaTg47OcMzC" --identifiers="cus_1szWVIyZES2MJoAMUmjwW" --dry-run

`raims customers get`

Get a customer

Shell

raims customers get ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for get
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json customers get ID --dry-run

`raims customers list`

List customers

Shell

raims customers list [flags]

--after string default: empty
- Read after this opaque cursor (cannot be combined with --before)
--all bool default: false
- Read all pages as separate results (JSON Lines with --output json)
--before string default: empty
- Read before this opaque cursor (cannot be combined with --after)
--document string default: empty
- Filter by customer tax ID
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--email string default: empty
- Filter by email address
--external-reference string default: empty
- Filter by external reference
--help, -h bool default: false
- help for list
--identifier string default: empty
- Filter by public resource identifier
--max-pages int default: 100
- Maximum pages to read with --all (1-10000)
--name string default: empty
- Filter by customer name
--page-size int64 default: 10
- Results per page (the API normalizes the requested size)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json customers list --dry-run

`raims customers update`

Update a customer

Shell

raims customers update ID [flags]

--body-null stringArray default: []
- Set a nullable JSON body field to null by its JSON name (repeat for each field; cannot be combined with --data-file)
--city string default: empty
- Set JSON body field city (string, nullable)
--complement string default: empty
- Set JSON body field complement (string, nullable)
--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dial-code string default: empty
- Set JSON body field dial_code (string, nullable)
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--email string default: empty
- Set JSON body field email (string, nullable)
--external-reference string default: empty
- Set JSON body field external_reference (string, nullable)
--full-name string default: empty
- Set JSON body field full_name (string, nullable)
--help, -h bool default: false
- help for update
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--metadata stringArray default: empty
- Set a metadata text value as KEY=VALUE (repeat for each key; dots in keys are literal)
--metadata-empty bool default: false
- Send an empty metadata object; an update preserves existing keys
--metadata-null stringArray default: []
- Send null for a metadata key (repeat for each key; removes it when updating)
--neigh string default: empty
- Set JSON body field neigh (string, nullable)
--phone-local string default: empty
- Set JSON body field phone_local (string, nullable)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--street string default: empty
- Set JSON body field street (string, nullable)
--street-number string default: empty
- Set JSON body field street_number (string, nullable)
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)
--uf string default: empty
- Set JSON body field uf (string, nullable)
--zip-code string default: empty
- Set JSON body field zip_code (string, nullable)

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.

Command example

Shell

raims --profile PROFILE --output json customers update ID --data-file request.json --dry-run
raims customers update ID --email="atualizado@example.invalid" --dry-run