⬆️Update Business

The Business information may be updated if required.

PATCH {{baseUrl}}/businesses/:business_id

Path Parameters

Name	Type	Description
business_id*	String	The UUID for a specific business that gets generated and returned in either POST Create a Business for a Customer or POST Create a Business without a Customer

Request Body

Name	Type	Description
name	String	The registered Business name.
reg	String	The Business Registration Number. Example: xxxx / xxxxxx / xx
enterprise_num	String	The Business Enterprise Number. Example: Kxxxxxxxxxx
type	String	The type of company the Business is legally registered as. Types of companies accepted: Private Company, Sole Proprietor, Public Company, Closed Corporation, Partnership, NGO, and Business Trust

API Responses

200: OK

{
    "data": {
        "id": "{{businessId}}",
        "name": "Changed Business Name",
        "type": "Private Company",
        "reg": "xxxx/xxxxxx/xx",
        "enterprise_num": "Kxxxxxxxxxx",
        "linked_customers": [],
        "cipc_business_verified": false,
        "cipc_director_verified": false,
        "cipc_information": null,
        "cipc_timestamp": null
    }
}

404: Not Found Missing businessId

{
    "errors": {
        "code": "entity_not_found",
        "message": "Record not found in businesses"
    }
}

Examples

Before: Available Business Information

{
    "data": {
        "id": "{{businessId}}",
        "name": "Finch Technologies",
        "type": "Private Company",
        "reg": "2015/123456/23",
        "enterprise_num":"K2016513771"
        "linked_customers": [],
        "cipc_business_verified": false,
        "cipc_director_verified": false,
        "cipc_information": null,
        "cipc_timestamp": null
    }
}

Patch: Updating the business name and business type

{
        "name": "Finch Technologies PTY LTD",
        "type": "Public Company"
}

After: Updated Business Information

{
    "data": {
        "id": "{{businessId}}",
        "name": "Finch Technologies PTY LTD",
        "type": "Public Company",
        "reg": "2015/123456/23",
        "enterprise_num":"K2016513771"
        "linked_customers": [],
        "cipc_business_verified": false,
        "cipc_director_verified": false,
        "cipc_information": null,
        "cipc_timestamp": null
    }
}