All URIs are relative to https://api.bombbomb.com/v2
| Method | HTTP request | Description |
|---|---|---|
| GetFacebookPages | Get /socials/facebook/pages | Gets facebook pages |
| GetSocialArticleProperties | Get /socials/properties | Gets the social email properties |
| GetSocialAuthorizations | Get /socials/authorizations | Get authorizations for all social integration |
| GetSocialProfileProperties | Get /socials/profile | Gets the profile properties |
| GetSocialStats | Get /socials/{promptId}/stats | Get social stats for a prompt |
| PostSocialContent | Post /socials/content | Creates social content |
| RetrySocialSend | Post /socials/send/retry | Sends social content |
| SendSocial | Post /socials/send | Sends social content |
| UpdateClientGroupSendMechanism | Put /socials/client/sendMechanism | Gets the auto shares from the client group assoc id |
| UpdateClientGroupsSendMechanism | Put /socials/client/sendMechanisms | Toggles the prompt campaigns in a users account |
| UpdateFacebookPages | Put /socials/facebook/pages | Updates facebook page Ids |
| UpdateSocialContent | Put /socials/content | Updates social content |
GetFacebookPages(ctx, ) Gets facebook pages
Gets facebook pages by client id
This endpoint does not need any parameter.
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSocialArticleProperties(ctx, emailId, socialContentId) Gets the social email properties
Gets the social email properties
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| emailId | string | This is the email Id for the email url | |
| socialContentId | string | This is the social content Id |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSocialAuthorizations(ctx, optional) Get authorizations for all social integration
Get authorizations and autoshares for all social integration and has redirect for user to login
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| clientGroupId | string | ID of the client group association |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSocialProfileProperties(ctx, socialType) Gets the profile properties
Gets the social profile properties
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| socialType | string | The social type |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSocialStats(ctx, promptId) Get social stats for a prompt
Get social stats for a prompt by id
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| promptId | string | ID of the prompt |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostSocialContent(ctx, emailId) Creates social content
Creates social content for an email
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| emailId | string | The email's id |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RetrySocialSend(ctx, promptId) Sends social content
Sends social content that failed for a user via their associated prompt
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| promptId | string | The prompt id |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SendSocial(ctx, promptId, socialType) Sends social content
Sends social content for a user via their associated prompt
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| promptId | string | The prompt id | |
| socialType | string | The destination for social content |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateClientGroupSendMechanism(ctx, sendMechanism, clientGroupId, optional) Gets the auto shares from the client group assoc id
Gets the auto shares from the client group assoc id
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| sendMechanism | string | The send mechanism for the prompt | |
| clientGroupId | string | ID of the client group association | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| sendMechanism | string | The send mechanism for the prompt | |
| clientGroupId | string | ID of the client group association | |
| enabled | string | Is the send mechanism enabled? |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateClientGroupsSendMechanism(ctx, sendMechanism, enabled) Toggles the prompt campaigns in a users account
Toggles the prompt campaigns in a users account for a social integrations on or off
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| sendMechanism | string | The send mechanism for the prompt | |
| enabled | string | Is the send mechanism enabled? |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateFacebookPages(ctx, pageIds) Updates facebook page Ids
Updates facebook page Ids to be sent to for prompts
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| pageIds | string | Page Ids for the prompt |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateSocialContent(ctx, socialId, optional) Updates social content
Updates social content for an email
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| socialId | string | The social id | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| socialId | string | The social id | |
| title | string | The title for the article | |
| description | string | The article description | |
| pictureUrl | string | The article picture url | |
| suggestedMessage | string | The suggested message to use |
(empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]