Skip to main content

Create a customer service record

POST 
/customer_service_records

Create a new customer service record for the provided phone number.

Request

Body

required

    phone_number stringrequired

    Possible values: Value must match regular expression ^\+1\d{10}$

    A valid US phone number in E164 format.

    webhook_url string

    Callback URL to receive webhook notifications.

    additional_data

    object

    name string

    The name of the administrator of CSR.

    authorized_person_name string

    The name of the authorized person.

    pin string

    The PIN of the customer service record.

    account_number string

    The account number of the customer service record.

    customer_code string

    The customer code of the customer service record.

    address_line_1 string

    The first line of the address of the customer service record.

    city string

    The city of the customer service record.

    state string

    Possible values: <= 2 characters, Value must match regular expression ^[A-Z]{2}$

    The state of the customer service record.

    zip_code string

    Possible values: <= 5 characters, Value must match regular expression ^\d{5}$

    The zip code of the customer service record.

    billing_phone_number string

    Possible values: Value must match regular expression ^\+1\d{10}$

    The billing phone number of the customer service record.

Responses

201: Successful Response

401: The required authentication headers were either invalid or not included in the request.

403: You do not have permission to perform the requested action on the specified resource or resources.

422: Unprocessable entity. Check the 'detail' field in response for details.

500: An unexpected error occurred.

Callbacks

Loading...