OCT-103 Gumlet outreach
POST/mixed/billing/details

Update organization billing details

Updates the organization's billing details. Supply the required company, tax, and address fields in the request body. The response contains the updated billing details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

7 body fields

Organization billing details. Include all listed fields when updating billing information.

address_linestringrequired

Address line 1

citystringrequired

Name of the city

company_namestringrequired

Company name

country_codestringrequired

ISO country code

gst_numberstringrequired

GST / VAT details of the company

postalstringrequired

Postal code of the company

state_codestringrequired

ISO code of the state / region

5 status codes
200Returns the updated billing details, including the company name, tax number, and address fields.
address_linestringrequired

Address line 1

citystringrequired

Name of the city

company_namestringrequired

Company name

country_codestringrequired

ISO country code

gst_numberstringrequired

GST / VAT details of the company

postalstringrequired

Postal code of the company

state_codestringrequired

ISO code of the state / region

400Returned when the request is invalid.

One documented failure

  • invalid_parameter

    Invalid parameter value.

errorobjectrequired
401Returned when the request omits or supplies an invalid API key or bearer token.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user has insufficient role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired
500Returned when an internal server error occurs.

One documented failure

  • internal_server_error

    We have encountered some server error. We have been notified and will fix it soon.

errorobjectrequired

Error handling

A 400 is returned when the request is invalid. A 401 is returned when the request omits or supplies an invalid API key or bearer token. A 403 is returned for an unpaid account or insufficient role permissions, and a 500 indicates an internal server error. The body must include address_line, city, company_name, country_code, gst_number, postal, and state_code.