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

Schema

    data

    object

    id uuid

    Uniquely identifies this customer service record

    phone_number string

    The phone number of the customer service record.

    status string

    Possible values: [pending, completed, failed]

    The status of the customer service record

    error_message string

    The error message in case status is failed. This field would be null in case of pending or completed status.

    result

    object

    The result of the CSR request. This field would be null in case of pending or failed status.

    carrier_name string

    The name of the carrier that the customer service record is for.

    associated_phone_numbers string[]

    The associated phone numbers of the customer service record.

    admin

    object

    The admin of the customer service record.

    name string

    The name of the customer service record.

    billing_phone_number string

    The billing phone number of the customer service record.

    account_number string

    The account number of the customer service record.

    authorized_person_name string

    The authorized person name of the customer service record.

    address

    object

    The address of the customer service record

    administrative_area string

    The state of the address

    locality string

    The city of the address

    postal_code string

    The zip code of the address

    street_address string

    The street address

    full_address string

    The full address

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was created.

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

Schema

    errors object[]

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

Schema

    errors object[]

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

Schema

    errors object[]

500: An unexpected error occurred.

Schema

    errors object[]

Callbacks

Loading...