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

     1  # A2pBrandRegistrationsApi
     2  
     3  All URIs are relative to *https://messaging.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateBrandRegistrations**](A2pBrandRegistrationsApi.md#CreateBrandRegistrations) | **Post** /v1/a2p/BrandRegistrations | 
     8  [**FetchBrandRegistrations**](A2pBrandRegistrationsApi.md#FetchBrandRegistrations) | **Get** /v1/a2p/BrandRegistrations/{Sid} | 
     9  [**ListBrandRegistrations**](A2pBrandRegistrationsApi.md#ListBrandRegistrations) | **Get** /v1/a2p/BrandRegistrations | 
    10  [**UpdateBrandRegistrations**](A2pBrandRegistrationsApi.md#UpdateBrandRegistrations) | **Post** /v1/a2p/BrandRegistrations/{Sid} | 
    11  
    12  
    13  
    14  ## CreateBrandRegistrations
    15  
    16  > MessagingV1BrandRegistrations CreateBrandRegistrations(ctx, optional)
    17  
    18  
    19  
    20  
    21  
    22  ### Path Parameters
    23  
    24  This endpoint does not need any path parameter.
    25  
    26  ### Other Parameters
    27  
    28  Other parameters are passed through a pointer to a CreateBrandRegistrationsParams struct
    29  
    30  
    31  Name | Type | Description
    32  ------------- | ------------- | -------------
    33  **CustomerProfileBundleSid** | **string** | Customer Profile Bundle Sid.
    34  **A2PProfileBundleSid** | **string** | A2P Messaging Profile Bundle Sid.
    35  **BrandType** | **string** | Type of brand being created. One of: \\\"STANDARD\\\", \\\"SOLE_PROPRIETOR\\\". SOLE_PROPRIETOR is for low volume, SOLE_PROPRIETOR use cases. STANDARD is for all other use cases.
    36  **Mock** | **bool** | A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.
    37  **SkipAutomaticSecVet** | **bool** | A flag to disable automatic secondary vetting for brands which it would otherwise be done.
    38  
    39  ### Return type
    40  
    41  [**MessagingV1BrandRegistrations**](MessagingV1BrandRegistrations.md)
    42  
    43  ### Authorization
    44  
    45  [accountSid_authToken](../README.md#accountSid_authToken)
    46  
    47  ### HTTP request headers
    48  
    49  - **Content-Type**: application/x-www-form-urlencoded
    50  - **Accept**: application/json
    51  
    52  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    53  [[Back to Model list]](../README.md#documentation-for-models)
    54  [[Back to README]](../README.md)
    55  
    56  
    57  ## FetchBrandRegistrations
    58  
    59  > MessagingV1BrandRegistrations FetchBrandRegistrations(ctx, Sid)
    60  
    61  
    62  
    63  
    64  
    65  ### Path Parameters
    66  
    67  
    68  Name | Type | Description
    69  ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **Sid** | **string** | The SID of the Brand Registration resource to fetch.
    72  
    73  ### Other Parameters
    74  
    75  Other parameters are passed through a pointer to a FetchBrandRegistrationsParams struct
    76  
    77  
    78  Name | Type | Description
    79  ------------- | ------------- | -------------
    80  
    81  ### Return type
    82  
    83  [**MessagingV1BrandRegistrations**](MessagingV1BrandRegistrations.md)
    84  
    85  ### Authorization
    86  
    87  [accountSid_authToken](../README.md#accountSid_authToken)
    88  
    89  ### HTTP request headers
    90  
    91  - **Content-Type**: Not defined
    92  - **Accept**: application/json
    93  
    94  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    95  [[Back to Model list]](../README.md#documentation-for-models)
    96  [[Back to README]](../README.md)
    97  
    98  
    99  ## ListBrandRegistrations
   100  
   101  > []MessagingV1BrandRegistrations ListBrandRegistrations(ctx, optional)
   102  
   103  
   104  
   105  
   106  
   107  ### Path Parameters
   108  
   109  This endpoint does not need any path parameter.
   110  
   111  ### Other Parameters
   112  
   113  Other parameters are passed through a pointer to a ListBrandRegistrationsParams struct
   114  
   115  
   116  Name | Type | Description
   117  ------------- | ------------- | -------------
   118  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   119  **Limit** | **int** | Max number of records to return.
   120  
   121  ### Return type
   122  
   123  [**[]MessagingV1BrandRegistrations**](MessagingV1BrandRegistrations.md)
   124  
   125  ### Authorization
   126  
   127  [accountSid_authToken](../README.md#accountSid_authToken)
   128  
   129  ### HTTP request headers
   130  
   131  - **Content-Type**: Not defined
   132  - **Accept**: application/json
   133  
   134  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   135  [[Back to Model list]](../README.md#documentation-for-models)
   136  [[Back to README]](../README.md)
   137  
   138  
   139  ## UpdateBrandRegistrations
   140  
   141  > MessagingV1BrandRegistrations UpdateBrandRegistrations(ctx, Sid)
   142  
   143  
   144  
   145  
   146  
   147  ### Path Parameters
   148  
   149  
   150  Name | Type | Description
   151  ------------- | ------------- | -------------
   152  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   153  **Sid** | **string** | The SID of the Brand Registration resource to update.
   154  
   155  ### Other Parameters
   156  
   157  Other parameters are passed through a pointer to a UpdateBrandRegistrationsParams struct
   158  
   159  
   160  Name | Type | Description
   161  ------------- | ------------- | -------------
   162  
   163  ### Return type
   164  
   165  [**MessagingV1BrandRegistrations**](MessagingV1BrandRegistrations.md)
   166  
   167  ### Authorization
   168  
   169  [accountSid_authToken](../README.md#accountSid_authToken)
   170  
   171  ### HTTP request headers
   172  
   173  - **Content-Type**: Not defined
   174  - **Accept**: application/json
   175  
   176  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   177  [[Back to Model list]](../README.md#documentation-for-models)
   178  [[Back to README]](../README.md)
   179