ReDoc documentation

customers/{customerId}/companies/{companyId}

customers/{customerId}/companies/{companyId}

put/V1/customers/{customerId}/companies/{companyId}

Assigns customer as a company user.

Request
path Parameters
companyId
required
integer
customerId
required
integer
Responses
401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "message": "string",
  • "errors": [
    ],
  • "code": 0,
  • "parameters": [
    ],
  • "trace": "string"
}

customers/{customerId}/companies/{companyId}

delete/V1/customers/{customerId}/companies/{companyId}

Unassigns customer from the company.

Request
path Parameters
companyId
required
integer
customerId
required
integer
Responses
401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "message": "string",
  • "errors": [
    ],
  • "code": 0,
  • "parameters": [
    ],
  • "trace": "string"
}

customers/{customerId}/companies/{companyId}

get/V1/customers/{customerId}/companies/{companyId}

Returns customer attributes for company by ID.

Request
path Parameters
companyId
required
integer
customerId
required
integer
Responses
200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

Response samples
{
  • "customer_id": 0,
  • "company_id": 0,
  • "job_title": "string",
  • "status": 0,
  • "telephone": "string",
  • "is_default": true,
  • "extension_attributes": { }
}
➔ Next to customers/{customerId}/confirm