github.com/twilio/twilio-go@v1.20.1/rest/trusthub/v1/docs/CustomerProfilesChannelEndpointAssignmentsApi.md (about)

     1  # CustomerProfilesChannelEndpointAssignmentsApi
     2  
     3  All URIs are relative to *https://trusthub.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateCustomerProfileChannelEndpointAssignment**](CustomerProfilesChannelEndpointAssignmentsApi.md#CreateCustomerProfileChannelEndpointAssignment) | **Post** /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments | 
     8  [**DeleteCustomerProfileChannelEndpointAssignment**](CustomerProfilesChannelEndpointAssignmentsApi.md#DeleteCustomerProfileChannelEndpointAssignment) | **Delete** /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid} | 
     9  [**FetchCustomerProfileChannelEndpointAssignment**](CustomerProfilesChannelEndpointAssignmentsApi.md#FetchCustomerProfileChannelEndpointAssignment) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid} | 
    10  [**ListCustomerProfileChannelEndpointAssignment**](CustomerProfilesChannelEndpointAssignmentsApi.md#ListCustomerProfileChannelEndpointAssignment) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments | 
    11  
    12  
    13  
    14  ## CreateCustomerProfileChannelEndpointAssignment
    15  
    16  > TrusthubV1CustomerProfileChannelEndpointAssignment CreateCustomerProfileChannelEndpointAssignment(ctx, CustomerProfileSidoptional)
    17  
    18  
    19  
    20  Create a new Assigned Item.
    21  
    22  ### Path Parameters
    23  
    24  
    25  Name | Type | Description
    26  ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **CustomerProfileSid** | **string** | The unique string that we created to identify the CustomerProfile resource.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a CreateCustomerProfileChannelEndpointAssignmentParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  **ChannelEndpointType** | **string** | The type of channel endpoint. eg: phone-number
    38  **ChannelEndpointSid** | **string** | The SID of an channel endpoint
    39  
    40  ### Return type
    41  
    42  [**TrusthubV1CustomerProfileChannelEndpointAssignment**](TrusthubV1CustomerProfileChannelEndpointAssignment.md)
    43  
    44  ### Authorization
    45  
    46  [accountSid_authToken](../README.md#accountSid_authToken)
    47  
    48  ### HTTP request headers
    49  
    50  - **Content-Type**: application/x-www-form-urlencoded
    51  - **Accept**: application/json
    52  
    53  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    54  [[Back to Model list]](../README.md#documentation-for-models)
    55  [[Back to README]](../README.md)
    56  
    57  
    58  ## DeleteCustomerProfileChannelEndpointAssignment
    59  
    60  > DeleteCustomerProfileChannelEndpointAssignment(ctx, CustomerProfileSidSid)
    61  
    62  
    63  
    64  Remove an Assignment Item Instance.
    65  
    66  ### Path Parameters
    67  
    68  
    69  Name | Type | Description
    70  ------------- | ------------- | -------------
    71  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    72  **CustomerProfileSid** | **string** | The unique string that we created to identify the CustomerProfile resource.
    73  **Sid** | **string** | The unique string that we created to identify the resource.
    74  
    75  ### Other Parameters
    76  
    77  Other parameters are passed through a pointer to a DeleteCustomerProfileChannelEndpointAssignmentParams struct
    78  
    79  
    80  Name | Type | Description
    81  ------------- | ------------- | -------------
    82  
    83  ### Return type
    84  
    85   (empty response body)
    86  
    87  ### Authorization
    88  
    89  [accountSid_authToken](../README.md#accountSid_authToken)
    90  
    91  ### HTTP request headers
    92  
    93  - **Content-Type**: Not defined
    94  - **Accept**: Not defined
    95  
    96  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    97  [[Back to Model list]](../README.md#documentation-for-models)
    98  [[Back to README]](../README.md)
    99  
   100  
   101  ## FetchCustomerProfileChannelEndpointAssignment
   102  
   103  > TrusthubV1CustomerProfileChannelEndpointAssignment FetchCustomerProfileChannelEndpointAssignment(ctx, CustomerProfileSidSid)
   104  
   105  
   106  
   107  Fetch specific Assigned Item Instance.
   108  
   109  ### Path Parameters
   110  
   111  
   112  Name | Type | Description
   113  ------------- | ------------- | -------------
   114  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   115  **CustomerProfileSid** | **string** | The unique string that we created to identify the CustomerProfile resource.
   116  **Sid** | **string** | The unique string that we created to identify the resource.
   117  
   118  ### Other Parameters
   119  
   120  Other parameters are passed through a pointer to a FetchCustomerProfileChannelEndpointAssignmentParams struct
   121  
   122  
   123  Name | Type | Description
   124  ------------- | ------------- | -------------
   125  
   126  ### Return type
   127  
   128  [**TrusthubV1CustomerProfileChannelEndpointAssignment**](TrusthubV1CustomerProfileChannelEndpointAssignment.md)
   129  
   130  ### Authorization
   131  
   132  [accountSid_authToken](../README.md#accountSid_authToken)
   133  
   134  ### HTTP request headers
   135  
   136  - **Content-Type**: Not defined
   137  - **Accept**: application/json
   138  
   139  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   140  [[Back to Model list]](../README.md#documentation-for-models)
   141  [[Back to README]](../README.md)
   142  
   143  
   144  ## ListCustomerProfileChannelEndpointAssignment
   145  
   146  > []TrusthubV1CustomerProfileChannelEndpointAssignment ListCustomerProfileChannelEndpointAssignment(ctx, CustomerProfileSidoptional)
   147  
   148  
   149  
   150  Retrieve a list of all Assigned Items for an account.
   151  
   152  ### Path Parameters
   153  
   154  
   155  Name | Type | Description
   156  ------------- | ------------- | -------------
   157  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   158  **CustomerProfileSid** | **string** | The unique string that we created to identify the CustomerProfile resource.
   159  
   160  ### Other Parameters
   161  
   162  Other parameters are passed through a pointer to a ListCustomerProfileChannelEndpointAssignmentParams struct
   163  
   164  
   165  Name | Type | Description
   166  ------------- | ------------- | -------------
   167  **ChannelEndpointSid** | **string** | The SID of an channel endpoint
   168  **ChannelEndpointSids** | **string** | comma separated list of channel endpoint sids
   169  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   170  **Limit** | **int** | Max number of records to return.
   171  
   172  ### Return type
   173  
   174  [**[]TrusthubV1CustomerProfileChannelEndpointAssignment**](TrusthubV1CustomerProfileChannelEndpointAssignment.md)
   175  
   176  ### Authorization
   177  
   178  [accountSid_authToken](../README.md#accountSid_authToken)
   179  
   180  ### HTTP request headers
   181  
   182  - **Content-Type**: Not defined
   183  - **Accept**: application/json
   184  
   185  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   186  [[Back to Model list]](../README.md#documentation-for-models)
   187  [[Back to README]](../README.md)
   188