large_Wavin case study background.png

medium_Wavin case study background.png

small_Wavin case study background.png

thumbnail_Wavin case study background.png

Wavin case study background.png

Learn how Wavin connected with their end-customers via a branded loyalty app and grew their user base 17x in the first 6 months.

large_Wavin rewards app 1.png

medium_Wavin rewards app 1.png

small_Wavin rewards app 1.png

thumbnail_Wavin rewards app 1.png

Wavin rewards app 1.png

Connect your loyalty program in Kustomer without researching its API, registering in a developer program, and getting your application approved. We take care of authentication, secure credentials storage, and token refreshes so you don't have to.

Kustomer

<p>Creates a new attachment document. Includes a temporary upload policy for uploading the file via POST request.</p>
<p>Any one of the following roles is required for this endpoint:</p>
<table>
<thead>
<tr>
<th>Legacy Role</th>
<th>Equivalent Permission Set Role</th>
</tr>
</thead>
<tbody><tr>
<td>org.user.note.write</td>
<td>org.permission.note.create</td>
</tr>
<tr>
<td>org.user.message.write</td>
<td>org.permission.message.create</td>
</tr>
</tbody></table>
<h3>Uploading Attachments</h3>
<p>Uploads are conducted by sending a multipart POST request to the URL found in the response object's <code>meta.upload.url</code> property. The request must be accompanied by the key/value pairs found in <code>meta.upload.fields</code> as standard form keys. The file should be included as the last key under the name "file".</p>


Create attachment

<p>Updates requested attachment. Upserts if attachment does not exist.</p>
<p>Any one of the following roles is required for this endpoint:</p>
<table>
<thead>
<tr>
<th>Legacy Role</th>
<th>Equivalent Permission Set Role</th>
</tr>
</thead>
<tbody><tr>
<td>org.admin.message.write</td>
<td>org.permission.message.update</td>
</tr>
</tbody></table>


Upsert Attachment

<p>Retrieves attachments using the attachment's unique ID or an array of unique IDs, if given.</p>
<p>Any one of the following roles is required for this endpoint:</p>
<table>
<thead>
<tr>
<th>Legacy Role</th>
<th>Equivalent Permission Set Role</th>
</tr>
</thead>
<tbody><tr>
<td>org.user.attachment.read</td>
<td>org.permission.attachment.read</td>
</tr>
</tbody></table>


Get attachments by ID

<p>Retrieves attachments using the attachment's unique ID for a specific message ID.</p>
<p>Any one of the following roles is required for this endpoint:</p>
<table>
<thead>
<tr>
<th>Legacy Role</th>
<th>Equivalent Permission Set Role</th>
</tr>
</thead>
<tbody><tr>
<td>org.user.attachment.read</td>
<td>org.permission.attachment.read</td>
</tr>
</tbody></table>


Get attachment by Message and Attachment ID  (Inbound or Outbound)

<p>Retrieves a paginated list of all brands belonging to your organization.</p>


Get Brands

Create Brand

Retrieves your organization's default brand, which is automatically created at registration.

Get Default Brand

Get Brand by ID

Update a Brand Resource

Creates a new message from a conversation.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.message.write|org.permission.message.create|

### NOTE
> Using this endpoint will result in a new message that will be associated with the same customer as the conversation.

### Authorization
`org.admin` role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy.  Otherwise, these attributes are automatically set by the token.

### Rate Limit
Messages are subject to a rate limit. A single client can create up to 120 messages per minute per customer.
Messages with `importedAt` in their body will not be subject to the rate limit.

A `429 Too Many Requests` response will be returned if the rate limit has been reached for a customer.

Create a Message from Conversation

Retrieves messages for a conversation.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.message.read|org.permission.message.read|

Get Messages by Conversation

Creates a new message.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.message.write|org.permission.message.create|

### Note
> If a conversation is specified, the message will be linked to the existing conversation.  Otherwise, a new
conversation will be created and associated with the message.

### Authorization
The `org.admin` role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy.  Otherwise, these attributes are automatically set by the token.

### Rate Limit
Messages are subject to a rate limit. A single client can create up to 120 messages per minute per customer.
Messages with `importedAt` in their body will not be subject to the rate limit.

A `429 Too Many Requests` response will be returned if the rate limit has been reached for a customer.

Create a Message by Customer

Retrieves messages for a specific customer using the unique customer ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.message.read|org.permission.message.read|

Get Messages by Customer

Creates a message.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.message.write|org.permission.message.create|

### Rate Limit
Messages are subject to a rate limit. A single client can create up to 120 messages per minute per customer.
Messages with `importedAt` in their body will not be subject to the rate limit.

A `429 Too Many Requests` response will be returned if the rate limit has been reached for a customer.

Create Message

Retrieves messages for the organization.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.message.read|org.permission.message.read|

Get Messages

Retrieves a single message using its unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.message.read|org.permission.message.read|

Get a Message

Updates a message.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.message.write|org.permission.message.update|

### Note
> This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single Message. See <a href="#rate-limiting">API Rate Limiting</a> for more information.

### Authorization
>`org.admin` role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy.  Otherwise, these attributes are automatically set by the token.

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Update a Message

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.message.write|org.permission.message.update|

### Note
> This endpoint is subject to "Object Rate Limiting", meaning that a single user is limited in how many updates they can make to a single Message. Please see the <a href="#rate-limiting">API Rate Limiting</a> section of the documentation for additional details.

### Authorization
>`org.admin` role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy.  Otherwise, these attributes are automatically set by the token.

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Update Message Attributes

Retrieves a single message using its unique external message ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.message.read|org.permission.message.read|

| Key		| Value		| Description		|
|-|-|-|
| externalID	| string	| Unique external ID of the message.	|

Get a Message by External ID

Get All Schedules

Creates a schedule.

Hours is an object where the key is the day index and the value is a hour tuple. 0 is Sunday, 1 is Monday, 2 is tuesday, etc.

Each hour tuple is an array with 2 values. Each value is the time of day represented in minutes. The first value is the start time and the second value is the end time.

For example, [480, 1020] represents 8:00AM - 5:00pm.

Create Schedule

Get Default Schedule

Get Schedule by ID

Modifies a schedule.

Hours is an object where the key is the day index and the value is a hour tuple. 0 is Sunday, 1 is Monday, 2 is tuesday, etc.

Each hour tuple is an array with 2 values. Each value is the time of day represented in minutes. The first value is the start time and the second value is the end time.

For example, [480, 1020] represents 8:00AM - 5:00pm.

Update Schedule by ID

Delete Schedule by ID

Creates a new company.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.company.write|org.permission.company.create|

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Create a Company

Retrieves all companies. You can optionally filter this list by company name or the unique external company ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.company.read|org.permission.company.read|

### Note
> If external ID and filter query params are both present, the filter param is ignored.

Get Companies

Retrieves a company using their unique company ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.company.read|org.permission.company.read|

Get Company by ID

Updates the attributes of a company.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.company.write|org.permission.company.update|

### Note
>This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single company attribute. See <a href="#rate-limiting">API Rate Limiting</a> for more information.

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Update Company Attributes

Retrieves all custom objects (KObjects) that are linked to a company using the unique klass name.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.company.read|org.permission.company.read|

Find Company KObjects

Creates companies in bulk.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.company.write|org.permission.company.create|

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Bulk Create Companies

Batch update multiple companies with this action.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.company.write|org.permission.company.update|

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Bulk Batch Update Companies

Creates a new conversation.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.write|org.permission.conversation.create|

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

### Rate Limit
Conversations are subject to a rate limit. A single client can create up to 120 conversations per minute per customer.
Conversations with `importedAt` in their body will not be subject to the rate limit.

A `429 Too Many Requests` response will be returned if the rate limit has been reached for a customer.

Create a Conversation

Retrieves a paginated list of conversations for the organization.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.read|org.permission.conversation.read|

Get Conversations

Retrieves a single conversation using its unique ID.
Also supports a 'multi-get' with a comma separated list of IDs.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.read|org.permission.conversation.read|

Get Conversation

Updates a conversation.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.write|org.permission.conversation.update|

### Note
> This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single conversation. See <a href="#rate-limiting">API Rate Limiting</a> for more information.

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Update Conversation

Updates a conversation's attributes using its unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.write|org.permission.conversation.update|

### Note
> This endpoint is subject to "Object Rate Limiting", meaning that a single user is limited in how many updates they can make to a single Conversation. Please see the <a href="#rate-limiting">API Rate Limiting</a> section of the documentation for additional details.

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Update Conversation Attributes

Delete conversation using its unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.delete|org.permission.conversation.delete|

Delete Conversation

Retrieves a single conversation using its unique external ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.read|org.permission.conversation.read|

Get Conversation by External ID

Retrieves a paginated list of conversation events using the conversation's unique ID. You can use the name and/or changed parameters to filter the results.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.event.read|org.permission.event.read|

Get Conversation Events

Create conversations in bulk.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.write|org.permission.conversation.create|

Bulk Create Conversations

Updates a bulk batch of conversations.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.write|org.permission.conversation.update|

Bulk Batch Update Conversations

Create a forward that will be sent via email.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation_forward.write|org.permission.conversation_forward.create|


### NOTE
> Creating a forward with a sendAt property will schedule the forward for delivery. Forwards will send all messages in a conversation.

Create a Forward by Conversation

Retrieves all forwarded conversations using the unique conversation ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.draft.read|org.permission.draft.read|

Get all Forwards by Conversation

Creates a new note within a conversation. Optionally, allows you to @ mention another user in the organization.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.note.read|org.permission.note.create|

### AUTHORIZATION
The `org.admin` role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy.  Otherwise, these attributes are automatically set by the token.

Create a Note within Conversation

Retrieves notes found in a specific conversation.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.note.read|org.permission.note.read|

Get Notes by Conversation

Adds tags to a conversation by name and/or the conversation's unique ID.  If the tag does not yet exist, it will be created.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.write|org.permission.conversation.create|

### Note
> This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single Conversation. See <a href="#rate-limiting">API Rate Limiting</a> for more information.

Append Tags to Conversation

Remove tags from a conversation by name and/or the conversation's unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.write|org.permission.conversation.delete|

### Note
> This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single Conversation. See <a href="#rate-limiting">API Rate Limiting</a> for more information.

Remove Tags from Conversation

Retrieves conversation_times by the unique ID of the related conversation.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.read|org.permission.conversation.read|

Get conversation times by conversation id

Retrieves conversation_times by their unique IDs.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.read|org.permission.conversation.read|

Get conversation time by ids

Get the metadata for the custom attributes of a specific resource.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.metadata.read|org.permission.metadata.read|
|org.admin.metadata.read||


Get Custom Attribute Metadata

Set the metadata for custom attributes on any of the available resources. The options
are included in the below schema and are dependent on the data type, as specified by the
suffix of the property name. The default displayName will be the "Title Cased" version of
the property name and the type will be automatically determined (i.e. a property named
"totalOrdersNum" will have a displayName of "Total Orders" if no alternative displayName is set
and a type "number").

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.admin.metadata.write|org.permission.metadata.update|

### Note
> Unlike the other property types, metadata for custom properties ending in "Id" must be configured before they can be used. When updating these properties, the values will be validated to ensure that the related object exists in Kustomer and is of the specified "target" type.

Update Custom Attribute Metadata

Creates a new customer record.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.write|org.permission.customer.create|

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Create a Customer

Retrieves all customers in your organization. Results include customer data, such as their phone number, sentiment score, and the last message in a conversation.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.read|org.permission.customer.read|

Get Customers

Retrieves a customer record using the customer's unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.read|org.permission.customer.read|

Get Customer by ID

Updates a customer using their unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.write|org.permission.customer.update|

### Note
> This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single customer. See <a href="#rate-limiting">API Rate Limiting</a> for more information.

#### Company
If you omit the company, the customer will no longer be linked to the company.

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Update Customer

Updates customer attributes.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.write|org.permission.customer.update|

### Note
> This endpoint is subject to "Object Rate Limiting", meaning that a single user is limited in how many updates they can make to a single Customer. Please see the <a href="#rate-limiting">API Rate Limiting</a> section of the documentation for additional details.

#### Company
If you omit the company, the customer will no longer be linked to it.

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Update Customer Attributes

Deletes a customer record using the unique customer ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.delete|org.permission.customer.delete|

Delete Customer

Retrieves a customer using their email address.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.read|org.permission.customer.read|

Get Customer by Email

Retrieves a customer using their unique external ID.  The externalId is typically the ID of the customer within your database or external service.  This allows you to uniquely create and identify users by mapping kustomer's unique customer ID to your unique customer ID in an external system.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.read|org.permission.customer.read|

Get Customer by External ID

Retrieves a customer using their phone number.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.read|org.permission.customer.read|

Get Customer by Phone

Create customers in bulk.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.write|org.permission.customer.create|

Bulk Create Customers

Updates a bulk batch of customers.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.write|org.permission.customer.update|

Bulk Batch Update Customers

Delete multiple customers in bulk.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.delete|org.permission.customer.delete|

Bulk Delete Customers

Retrieves all outbound drafts to a customer using the customer's unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.draft.read|org.permission.draft.read|

Get all Drafts by Customer

Create an outbound draft to a customer through a channel.

You can also create note drafts by specifying the channel as 'note'. You can have one note draft per conversation.

### Rate Limit
Customer drafts are subject to a rate limit. A single client can create up to 120 drafts per minute per customer, including drafts scheduled for the future.

A `429 Too Many Requests` response will be returned if the rate limit has been reached for a customer.

Create a Draft by Customer

Retrieves a single customer event using their unique IDs.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.event.read|org.permission.event.read|

Get a Customer Event

Retrieves all tracking events for a specific customer session using their unique IDs.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.event.read|org.permission.event.read|

Get all Events by Customer for Session

Retrieves all events for a customer using their unique customer ID.

**Note:** This endpoint has been deprecated. We recommend using **Get all Events by Customer for Session** and **Get Conversation Events** instead. This endpoint will be removed on August 24, 2020 after which a 404 Not Found error will be returned by the API.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.event.read|org.permission.event.read|

Get all Customer Events

Retrieves all sessions for a single customer using the unique customer ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.event.read|org.permission.event.read|

Get Customer Sessions

Create a new, empty conversation for a customer.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.write|org.permission.conversation.create|

#### Custom Attributes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Create a Conversation for a Customer

Retrieves a paginated list of conversations using the customer's unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.conversation.read|org.permission.conversation.read|

Get Conversations by Customer

Creates a new custom object and links it to a customer using the unique customer ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.kobject.write|org.permission.kobject.create|
||org.permission.kobject.kobject_*.create|

Create Customer KObject

Finds all KObjects linked to a customer by Klass name.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.read|org.permission.customer.read|

Find Customer KObjects

Creates a customer merge specifying a source and target set of customer IDs.  The merge will use the following rules:
- Union / Merge the following fields:
    - Emails, Phones
    - Socials
    - Locations
    - Watchers
    - Custom - target takes precedence with same attribute names
    - Tags
    - KlassNames
    - conversationCounts - Sum all values
- Chosen based on most recent:
    - Preview - Based on preview.previewAt
    - LastMessageIn - Based on lastMessageIn.sentAt
    - lastConversation - Based on lastMessageIn.sentAt
    - recentLocation - Based on recentLocation.updatedAt
    - signedUpAt
    - modifiedAt / modifiedBy
    - lastSeenAt
    - lastActivityAt
- Chosen based on oldest:
    - createdAt / createdBy
- Target takes precedence
    - Company
    - name,
    - externalId,
    - username,
    - avatarUrl,
    - locale,
    - timeZone,
    - birthdayAt,
    - gender

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.write|org.permission.customer_merge.create|
|org.admin.customer.merge.write|

Create a Customer Merge

Retrieve an existing customer merge using the unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.read|org.permission.customer_merge.create|
|org.admin.customer.merge.read|

Get a Customer Merge

Retrieve a customer merges using the customer's unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.customer.read|org.permission.customer_merge.read|
|org.admin.customer.merge.read|

Get Customer Merges by Customer

Retrieves notes for a specific customer using the unique customer ID. Notes are internal communications visible only to users in an org.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.note.read|org.permission.note.read|

Get Notes by Customer

Get a Draft Forward By ID

Updates a forward.
If the sendAt property is updated to a valid timestamp, the forward will be scheduled to be sent and updated to a scheduled status.
If the sendAt property is not included, the draft's status will not be affected.

### Request Body Details

|  Name  | Detail |
| ------------- | ------------- |
| body  | The message body included with the forwarded conversation. |
| from  | The email address sending the forward. |
| lang  | Describes the language of the object's contents |
| sendAt  | A date in ISO format. Including this property will schedule the forward to be delivered. |
| status  | The status of the forward. A draft status indicates the forward is not scheduled for delivery and still editable. A scheduled status indicates the forward is scheduled for delivery by an email app (postmark or gmail). A draft will be update to a failed or sent status after a delivery attempt.  |
| subject  | The subject of the forwarded conversation. |
| template  | The ID of a template that should be used for the forward. |
| to  | The destination email address of the forward. This an array that can accept more than one email recipient. |

Update a Draft Forward

Get Outbound Accounts

Updates a draft. Any properties available in the channel can be updated via this endpoint.
If the sendAt property is updated to a valid timestamp, the draft will
be scheduled to be sent. If the sendAt property is empty, the draft will be unscheduled.
If the sendAt property is not included, the draft's status will not be affected.

Update a Draft

Delete a Draft

Create an attachment on a draft.

### Pre-signed URL

When creating an attachment, the response will include a **related** URL in the **links** section.  You can use this URL to upload the contents of the attachment.  This URL is a Pre-Signed URL from S3 which provides access for a limited duration to upload a file.

Example command to upload an attachment to the related Pre-Signed URL:

```bash
$ curl --upload-file [full path to file] "[Pre-Signed URL]"
```

Create Draft Attachment

Get Draft Attachments

Get a draft attachment.

### Pre-signed URL

When requesting the resource, the response will include a **related** URL in the **links** section.  You can use this URL to download the attachment file.  This URL is a Pre-Signed URL from S3 which provides access for a limited duration to download a file.

Get Draft Attachment

Delete Draft Attachment

Creates a new Klass model.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.admin.klass.write|org.permission.klass.create|

Create a Klass

Retrieves all Klasses.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.klass.read|org.permission.klass.read|
|org.admin.klass.read||

Get Klasses

Retrieves a Klass using its unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.klass.read|org.permission.klass.read|
|org.admin.klass.read||

Get Klass

Updates Klass attributes using its unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.admin.klass.write|org.permission.klass.update|

Update a Klass

Deletes a Klass using its unique ID. You cannot delete a Klass if KObjects exist for it.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.admin.klass.write|org.permission.klass.delete|

Delete a Klass

Retrieves a KObject by Klass Name.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.klass.read|org.permission.klass.read|
|org.admin.klass.read||

Get KObjects

Creates a new custom object.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.kobject.write|org.permission.kobject.create|
||org.permission.kobject.kobject_*.create|

#### Custom Attibutes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

### Rate Limit
Custom objects are subject to a rate limit. A single client can create up to 120 custom objects per minute per customer.
Custom objects with `importedAt` in their body will not be subject to the rate limit.

A `429 Too Many Requests` response will be returned if the rate limit has been reached for a customer.

Create KObject

Retrieves a KObject using its unique ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.kobject.read|org.permission.kobject.read|
||org.permission.kobject.kobject_*.read|

Get KObject

Updates an existing custom object.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.kobject.write|org.permission.kobject.update|
||org.permission.kobject.kobject_*.update|

### Note
> This endpoint is subject to "Object Rate Limiting", meaning that a single user is limited in how many updates they can make to a single KObject. Please see the <a href="#rate-limiting">API Rate Limiting</a> section of the documentation for additional details.

#### Custom Attibutes
Custom attributes are optional and allow you to specify
custom key value pairs. They follow a convention which
allows us to specify the field data type with a name suffix:

##### Suffix
* `Num` <number> or *null*
* `At` <dateTime> or *null*
* `Str` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Txt` <string> or *null*, **length**: [ 0 .. 1024 ] characters
* `Bool` <boolean> or *null*
* `Url` <string> or *null*, format: <uri>

Update KObject

Deletes a KObject using the unique KObject ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.kobject.delete|org.permission.kobject.delete|
||org.permission.kobject.kobject_*.delete|

Delete KObject

Create KObjects in bulk.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.kobject.write|org.permission.kobject.create|
||org.permission.kobject.kobject_*.create|

Bulk Create KObjects

Updates a batch of multiple KObjects.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.kobject.write|org.permission.kobject.update|
||org.permission.kobject.kobject_*.update|

Bulk Batch Update KObjects

Deletes multiple KObjects in bulk.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.user.kobject.delete|org.permission.kobject.delete|
||org.permission.kobject.kobject_*.delete|

White Label Loyalty + Kustomer integration

About Kustomer

Similar Integrations

Zoho Desk

Teamwork

Zendesk

Bitbucket

Benefits of White Label Loyalty + Kustomer

Integrate now!

Automate desired actions with Kustomer

Create attachment

Uploading Attachments

Get attachment by Message and Attachment ID (Inbound or Outbound)

Upsert Attachment

Get Brands

Get attachments by ID

Create Brand

Wavin

Choose White Label Loyalty and become a loyalty leader

Legacy Role	Equivalent Permission Set Role
org.user.note.write	org.permission.note.create
org.user.message.write	org.permission.message.create