# Read social asset by id

Endpoint: GET /sam/{assetId}
Version: 3.0.0
Security: bearerAuth, apiKeyAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer Token

  - `apiKeyAuth` (unknown)
    apiKey in header Key

## Path parameters:

  - `assetId` (string, required)
    Social asset id

## Response 200:

  - `200` (unknown)
    Success

## Response 200 fields (application/json):

  - `id` (string, required)
    Id of the asset.

  - `name` (string, required)
    Name of the asset.

  - `description` (string, required)
    Description for the asset.

  - `status` (string, required)
    Status of the asset.

  - `taxonomy` (object, required)
    Taxonomy of the asset.

  - `taxonomy.name` (string)
    name of the message

  - `taxonomy.campaignId` (string, required)
    campaign identifier to associate the message to

  - `taxonomy.subCampaignId` (string)
    sub campaign identifier to associate the message to

  - `taxonomy.clientCustomProperties` (object)
    client custom properties for the message

  - `taxonomy.partnerCustomProperties` (object)
    partner custom properties for the message

  - `taxonomy.tags` (array)
    tags to be added to the message

  - `taxonomy.urlShortenerId` (string)
    url shortner identifier to apply to the message

  - `insights` (object)
    Collective insights of the posts on social channels. e.g. likes, comments, shares

  - `validity` (object)
    Asset validity details. e.g expiry, available from

  - `validity.expiryTime` (integer)
    Asset expiry time. This option is not valid if neverExpire is true

  - `validity.availableFrom` (integer)
    Asset is available from time.

  - `validity.neverExpire` (boolean)
    True if asset will never expire.

  - `validity.visibleFrom` (integer)
    Visibility of asset from specified time

  - `validity.visibleTill` (integer)
    Visibility of asset until specified time

  - `parentId` (string)
    Parent Asset Id.

  - `assetSource` (string)
    Source of the Asset. e.g. SPRINKLR, GETTY, SHUTTERSTOCK

  - `sourceId` (string)
    Source Id of the Asset.

  - `externalMediaId` (string)
    Media Id from the external source, populated when assetSource is not SPRINKLR

  - `actionStats` (object)
    Stats of the asset actions. e.g Download, Published

  - `shareConfigs` (array)
    Asset share config

  - `shareConfigs.type` (string, required)
    Type e.g. USER, GLOBAL, CLIENT

  - `shareConfigs.ids` (array)
    IDs based on type.

  - `restricted` (boolean)
    True if asset is restricted from publishing

  - `locked` (boolean)
    True if asset is locked

  - `createdTime` (integer)
    createdTime of Social Asset

  - `modifiedTime` (integer)
    modifiedTime of Social Asset

  - `defaultLocale` (string)
    Default locale for Social Asset

  - `langVsTranslatedFieldValues` (object)
    Language vs Translated Metadata for Social Asset

  - `approvedByUser` (integer)

  - `createdByUser` (integer)

  - `versionId` (integer)

  - `assetType` (string, required)
    Type of the asset.
    Enum: "PRESENTATION", "PHOTO", "VIDEO", "AUDIO", "FLASH", "HTML", "PDF", "DOC", "DOCX", "EXCEL", "ZIP", "PSD", "SKETCH", "FONT", "SUBTITLE", "TEMPLATE_ASSET", "RAR", "SVG", "EML", "MSG", "EDB", "ICS", "EPS", "INDD", "LINK", "POST", "RICH_TEXT", "TEXT", "POLL"

  - `attachment` (any, required)
    Attachment for the asset.

  - `attachment.type` (string, required)
    Type of attachment

  - `attachment.assetId` (string)
    Sprinklr Asset Id

  - `attachment.attachmentOptions` (array)
    Array of attachment properties per channel and/or account.

  - `attachment.attachmentOptions.channelType` (string, required)
    ChannelType for media options.

  - `attachment.attachmentOptions.accountId` (integer)
    If the properties are specific to an account inaddition to channelType, accountId can be specified and the properties would then only be used for the given account.

  - `attachment.attachmentOptions.embeddable` (boolean)
    To specify if the video is embeddable. Is used only when the attachment is of type VIDEO

  - `attachment.attachmentOptions.category` (string)
    To specify the content category of the video . Is used only when the attachment is of type VIDEO

  - `attachment.attachmentOptions.noStory` (boolean)
    If set to true, this will suppress Facebook feed and timeline story. Is used only when the attachment is of type VIDEO

  - `attachment.attachmentOptions.secret` (boolean)
    If set to true, this video will not appear anywhere on Facebook and is not searchable. It can be viewed and shared using permalink and embeds. Default value is false.

  - `attachment.attachmentOptions.blockSocialActions` (boolean)

  - `attachment.attachmentOptions.expirationEnabled` (boolean)
    If set to true, video is set to expiry. The time for video expiry must be specified via expirationDate.

  - `attachment.attachmentOptions.expirationDate` (integer)
    If expirationEnabled is set to true, this field is required and specifies the expiry date for the video.

  - `attachment.attachmentOptions.deletePost` (boolean)
    If expirationEnabled is set to true, deletePost specifies where to delete the post after expiry or only expire on Facebook.

  - `attachment.attachmentOptions.embeddable` (boolean)
    Allow embedding the video when posted to twitter. It is used only when attachment is VIDEO

  - `attachment.attachmentOptions.videoCategories` (array)
    Video categories

  - `attachment.attachmentOptions.blackListCategories` (array)
    Blacklist categories

  - `attachment.attachmentOptions.locationId` (string)
    To specify the tagged location

  - `attachment.attachmentOptions.userTags` (array)
    To specify tagged users in a media

  - `attachment.attachmentOptions.userTags.username` (string, required)
    Username of the user on channel.

  - `attachment.attachmentOptions.userTags.displayName` (string)
    Display Name of the user on channel.

  - `attachment.attachmentOptions.userTags.url` (string)
    Profile Link of the user on channel.

  - `attachment.attachmentOptions.userTags.x` (number)
    X location for the tag, must be a float number that specifies the x distance from top left corner, within range 0.0-1.0

  - `attachment.attachmentOptions.userTags.y` (number)
    Y location for the tag, must be a float number that specifies the y distance from top left corner, within range 0.0-1.0

  - `attachment.attachmentOptions.collaborators` (array)
    Instagram collaborators for collab posts

  - `attachment.attachmentOptions.collaborators.username` (string, required)
    Instagram username of the collaborator

  - `attachment.attachmentOptions.visibility` (string)
    To specify the video visibility

  - `attachment.attachmentOptions.license` (string)
    To specify the video license

  - `attachment.attachmentOptions.category` (string)
    To specify the video category

  - `attachment.attachmentOptions.tags` (array)
    To specify the video tags

  - `attachment.attachmentOptions.playlistsInfo` (array)
    To specify the video playlists details

  - `attachment.attachmentOptions.embeddable` (boolean)
    To specify if video can be embedded

  - `attachment.attachmentOptions.notifySubscribers` (boolean)
    To specify if subscribers should be notified

  - `attachment.attachmentOptions.madeForKids` (boolean)
    To specify if the video is made for kids

  - `attachment.attachmentOptions.playlistId` (string)

  - `attachment.attachmentOptions.playlistName` (string)

  - `attachment.attachmentOptions.playlistPosition` (string)

  - `attachment.url` (string)
    Url of the image to publish.

  - `attachment.urlHash` (string)
    Hashed Url of the image to publish.

  - `attachment.title` (string)
    Title for the image, if any.

  - `attachment.description` (string)
    Description for the image, if any.

  - `attachment.previewUrl` (string)
    Preview url of the image

  - `attachment.hashedPreviewUrl` (string)
    Hashed Preview url of the image

  - `attachment.mimeType` (string)
    Content-type of the image

  - `attachment.alternateText` (string)
    Alt text of the image

  - `attachment.height` (number)
    Image height of the image

  - `attachment.width` (number)
    Image width of the image

  - `attachment.encryptedUrl` (string)
    Encrypted url of the image to publish

  - `attachment.sizeInBytes` (integer)
    Size of media in bytes

  - `attachment.url` (string)
    Url of the video to publish.

  - `attachment.urlHash` (string)
    Hashed Url of the video to publish.

  - `attachment.previewUrl` (string)
    Url of the Preview Image of the video, only used when customization of preview url is supported by the channel.

  - `attachment.hashedPreviewUrl` (string)
    Hashed Url of the Preview Image of the video, only used when customization of preview url is supported by the channel.

  - `attachment.title` (string)
    Title for the video, if any.

  - `attachment.description` (string)
    Description for the video, if any.

  - `attachment.alternateText` (string)
    Alt text of the video

  - `attachment.mimeType` (string)
    Content-type of the video

  - `attachment.closedCaptions` (array)
    Captions of the video

  - `attachment.closedCaptions.title` (string, required)
    Title of the file

  - `attachment.closedCaptions.url` (string, required)
    Url of the file

  - `attachment.closedCaptions.languageCode` (string, required)
    Language of the caption

  - `attachment.closedCaptions.extension` (string, required)
    Extension of the file

  - `attachment.thumbnails` (array)
    Custom Thumbnails for the video

  - `attachment.rate` (number)
    Video rate of the video

  - `attachment.duration` (number)
    Duration of the video

  - `attachment.encryptedUrl` (string)
    Encrypted url of the video to publish

  - `attachment.url` (string)
    Link url.

  - `attachment.urlHash` (string)
    Hashed Link url.

  - `attachment.title` (string)
    Title for the link, if any.

  - `attachment.description` (string)
    Description for the link, if any.

  - `attachment.previewImageUrl` (string)
    Image Url for the link preview.

  - `attachment.hashedPreviewImageUrl` (string)
    Hashed Image Url for the link preview.

  - `attachment.url` (string)
    Url of the document source.

  - `attachment.title` (string)
    Title for the document, if any.

  - `attachment.description` (string)
    Description for the document, if any.

  - `attachment.alternateText` (string)
    Alt text of the document

  - `attachment.previewImageUrl` (string)
    Preview image of the document, if any

  - `attachment.previewUrl` (string)
    Preview URL of the document, if any

  - `attachment.mimeType` (string)
    Mimetype of the document, if any

  - `attachment.encryptedUrl` (string)
    Encrypted url of the document to publish

  - `attachment.base64EncodedContent` (string)
    base64 encoded content.

  - `attachment.fileName` (string)
    Filename for the content.

  - `attachment.title` (string)
    Title for the content, if any.

  - `attachment.description` (string)
    Description for the content, if any.

  - `attachment.cardAttachmentList` (array)
    List of cards in the carousel

  - `attachment.cardAttachmentList.type` (string, required)
    Type of attachment

  - `attachment.cardAttachmentList.assetId` (string)
    Sprinklr Asset Id

  - `attachment.cardAttachmentList.attachmentOptions` (array)
    Array of attachment properties per channel and/or account.

  - `attachment.cardAttachmentList.title` (string)
    Title of the card.

  - `attachment.cardAttachmentList.description` (string)
    Description of the card.

  - `attachment.cardAttachmentList.previewImageUrl` (string)
    Preview Url of the image.

  - `attachment.cardAttachmentList.disableManualResponse` (boolean)
    Boolean flag to disable manual response

  - `attachment.cardAttachmentList.buttons` (array)
    Buttons used in the card

  - `attachment.cardAttachmentList.buttons.id` (string)
    Id of the button

  - `attachment.cardAttachmentList.buttons.title` (string)
    Title of the button

  - `attachment.cardAttachmentList.buttons.subtitle` (string)
    Subtitle of the button.

  - `attachment.cardAttachmentList.buttons.imageUrl` (string)
    Image URL of the button

  - `attachment.cardAttachmentList.buttons.payload` (string)
    Payload of the button

  - `attachment.cardAttachmentList.buttons.actionDetail` (any)
    Action detail of the button.

  - `attachment.cardAttachmentList.buttons.actionDetail.serialVersionUID` (object)
    Unresolved type (staticfinallong)

  - `attachment.cardAttachmentList.buttons.actionDetail.action` (string, required)
    Type of Action

  - `attachment.cardAttachmentList.buttons.actionDetail.url` (string)
    URL to be opened in quick reply

  - `attachment.cardAttachmentList.buttons.actionDetail.urlType` (object)
    describe the URL Type

  - `attachment.cardAttachmentList.buttons.actionDetail.target` (string)
    target of open url in quick reply

  - `attachment.cardAttachmentList.buttons.actionDetail.value` (string)

  - `attachment.cardAttachmentList.buttons.actionDetail.accountLinkUrl` (string)
    URL for Account Link

  - `attachment.cardAttachmentList.buttons.actionDetail.postBackHandlerType` (string)
    Post back handler type

  - `attachment.cardAttachmentList.buttons.actionDetail.params` (string)
    Params for external params.

  - `attachment.cardAttachmentList.buttons.actionDetail.uri` (string)
    URI for external action.

  - `attachment.cardAttachmentList.buttons.actionDetail.data` (string)

  - `attachment.cardAttachmentList.buttons.actionDetail.displayText` (string)

  - `attachment.cardAttachmentList.buttons.actionDetail.countryCode` (string)
    Country Code of phone number

  - `attachment.cardAttachmentList.buttons.actionDetail.phoneNumber` (string)
    Phone Number for dialing

  - `attachment.cardAttachmentList.buttons.actionDetail.replyText` (string)
    text to reply

  - `attachment.cardAttachmentList.buttons.actionDetail.label` (string)
    label

  - `attachment.cardAttachmentList.buttons.actionDetail.code` (string)
    code to be copied

  - `attachment.cardAttachmentList.buttons.actionDetail.codeType` (object)
    describes the code type

  - `attachment.cardAttachmentList.buttons.actionDetail.value` (object)
    Unresolved type (finalString)

  - `attachment.cardAttachmentList.buttons.placeholders` (array)
    placeholders detail for button.

  - `attachment.cardAttachmentList.buttons.placeholders.assetClass` (string)
    The name of the Asset class used in the placeholder.

  - `attachment.cardAttachmentList.buttons.placeholders.customFieldName` (string)
    The name of the custom field used in the placeholder.

  - `attachment.cardAttachmentList.buttons.placeholders.displayName` (string)
    display Name for placeholder.

  - `attachment.cardAttachmentList.buttons.placeholders.resolvedValue` (string)
    Resolved Value for placeholder.

  - `attachment.cardAttachmentList.buttons.example` (array)
    examples of placeholders

  - `attachment.cardAttachmentList.defaultButton` (object)
    Default Button used in the card

  - `attachment.cardAttachmentList.reSubmittable` (boolean)
    Boolean flag of whether the card is re-submittable in Live Chat

  - `attachment.cardAttachmentList.postSubmitImageUrl` (string)
    Image Url after submitting in Live Chat

  - `attachment.cardAttachmentList.postSubmitSubtitle` (string)
    Subtitle after submitting in Live Chat

  - `attachment.cardAttachmentList.postSubmitTitle` (string)
    Title after submitting in Live Chat

  - `attachment.cardAttachmentList.header` (object)
    Header for Whatsapp interactive messages

  - `attachment.cardAttachmentList.header.text` (string)

  - `attachment.cardAttachmentList.footerText` (string)
    Footer text for Whatsapp interactive messages

  - `attachment.mediaAttachmentList` (array)
    List of medias in the carousel

  - `attachment.disableManualResponse` (boolean)
    Boolean flag to disable manual response in Live Chat.

  - `attachment.reSubmittable` (boolean)
    Boolean flag of whether the carousel is re-submittable in Live Chat

  - `attachment.postSubmitImageUrl` (string)
    Image Url after submitting in Live Chat

  - `attachment.postSubmitSubtitle` (string)
    Subtitle after submitting in Live Chat

  - `attachment.postSubmitTitle` (string)
    Title after submitting in Live Chat

  - `attachment.clickThroughUrl` (string)
    Click Through Url

  - `attachment.title` (string)
    Title of the carousel

  - `attachment.description` (string)
    Description of the carousel

  - `attachment.buttons` (array)
    Buttons for the carousel

  - `attachment.disableUserFeedback` (boolean)
    Boolean flag to disable user feedback

  - `attachment.hideAttachment` (boolean)
    Boolean flag to hide attachment

  - `attachment.screenReaderLabel` (string)
    Screen reader label

  - `attachment.otherConfigs` (object)
    Additional configuration for the template

  - `attachment.attachments` (array)
    list of attachment. can be of same or different types

  - `attachment.latitude` (number)
    Latitude of the location

  - `attachment.longitude` (number)
    Longitude of the location

  - `attachment.address` (string)
    Address of the location

  - `attachment.name` (string)
    Name of the location

  - `attachment.title` (string)
    Title of the card.

  - `attachment.description` (string)
    Description of the card.

  - `attachment.previewImageUrl` (string)
    Preview Url of the image.

  - `attachment.disableManualResponse` (boolean)
    Boolean flag to disable manual response

  - `attachment.buttons` (array)
    Buttons used in the card

  - `attachment.defaultButton` (object)
    Default Button used in the card

  - `attachment.reSubmittable` (boolean)
    Boolean flag of whether the card is re-submittable in Live Chat

  - `attachment.header` (object)
    Header for Whatsapp interactive messages

  - `attachment.footerText` (string)
    Footer text for Whatsapp interactive messages

  - `attachment.tAndC` (object)
    Terms and Conditions button

  - `attachment.message` (string)
    Message for the quick reply being sent.

  - `attachment.mediaAttachment` (any)
    An associated media with the quick reply, supported in twitter.

  - `attachment.quickReplies` (array)
    Quick reply options being used.

  - `attachment.disableManualResponse` (boolean)
    Boolean flag to disable manual response.

  - `attachment.url` (string)
    Url of the Audio source.

  - `attachment.urlHash` (string)
    Hashed Url of the Audio source.

  - `attachment.title` (string)
    Title for the Audio, if any.

  - `attachment.previewImageUrl` (string)
    Preview url of the Audio, if any

  - `attachment.hashedPreviewImageUrl` (string)
    Hashed Preview url of the Audio, if any

  - `attachment.mimeType` (string)
    Mimetype of the Audio, if any

  - `attachment.encryptedUrl` (string)
    Encrypted url of the audio to publish

  - `attachment.receivedMessage` (object)
    Unresolved type (MessageView)

  - `attachment.replyMessage` (object)
    Unresolved type (MessageView)

  - `attachment.title` (string)

  - `attachment.subtitle` (string)

  - `attachment.secondarySubtitle` (string)

  - `attachment.tertiarySubtitle` (string)

  - `attachment.imageTitle` (string)

  - `attachment.imageSubtitle` (string)

  - `attachment.style` (string)

  - `attachment.imageUrl` (string)

  - `attachment.scope` (array)

  - `attachment.loginAppConfigId` (string)

  - `attachment.additionalParameters` (object)

  - `attachment.type` (string)

  - `attachment.paymentRequest` (object)

  - `attachment.paymentRequest.lineItems` (array)

  - `attachment.paymentRequest.total` (object)
    Unresolved type (PaymentItem)

  - `attachment.paymentRequest.applePay` (object)
    Unresolved type (ApplePay)

  - `attachment.paymentRequest.merchantName` (string)

  - `attachment.paymentRequest.countryCode` (string)

  - `attachment.paymentRequest.currencyCode` (string)

  - `attachment.paymentRequest.requiredBillingContactFields` (array)

  - `attachment.paymentRequest.requiredShippingContactFields` (array)

  - `attachment.paymentRequest.supportedCountries` (array)

  - `attachment.paymentRequest.shippingMethods` (array)

  - `attachment.paymentRequest.label` (string)

  - `attachment.paymentRequest.amount` (string)

  - `attachment.paymentRequest.type` (string)

  - `attachment.paymentRequest.merchantIdentifier` (string)

  - `attachment.paymentRequest.supportedNetworks` (array)

  - `attachment.paymentRequest.merchantCapabilities` (array)

  - `attachment.paymentRequest.detail` (string)

  - `attachment.paymentRequest.identifier` (string)

  - `attachment.state` (string)

  - `attachment.paymentAccountId` (string)

  - `attachment.lineItems` (array)

  - `attachment.total` (object)
    Unresolved type (PaymentItem)

  - `attachment.applePay` (object)
    Unresolved type (ApplePay)

  - `attachment.merchantName` (string)

  - `attachment.countryCode` (string)

  - `attachment.currencyCode` (string)

  - `attachment.requiredBillingContactFields` (array)

  - `attachment.requiredShippingContactFields` (array)

  - `attachment.supportedCountries` (array)

  - `attachment.shippingMethods` (array)

  - `attachment.supportedNetworks` (array)

  - `attachment.merchantCapabilities` (array)

  - `attachment.label` (string)

  - `attachment.detail` (string)

  - `attachment.amount` (string)

  - `attachment.identifier` (string)

  - `attachment.appId` (string)

  - `attachment.appName` (string)

  - `attachment.bId` (string)

  - `attachment.url` (string)

  - `attachment.attachments` (array)

  - `attachment.useLiveLayout` (boolean)

  - `attachment.multipleSelection` (boolean)

  - `attachment.sections` (array)

  - `attachment.sections.id` (string)

  - `attachment.sections.type` (string)

  - `attachment.sections.title` (string)

  - `attachment.sections.name` (string)

  - `attachment.sections.pinCount` (integer)

  - `attachment.sections.board` (object)

  - `attachment.sections.board.id` (string)

  - `attachment.sections.board.type` (string)

  - `attachment.sections.board.category` (string)

  - `attachment.sections.board.access` (array)

  - `attachment.sections.board.collabBoardEmail` (boolean)

  - `attachment.sections.board.collaboratedByMe` (boolean)

  - `attachment.sections.board.collaboratorCount` (integer)

  - `attachment.sections.board.collaboratorInviteCounts` (object)

  - `attachment.sections.board.cover` (object)

  - `attachment.sections.board.coverImages` (object)

  - `attachment.sections.board.createdAt` (integer)
    Epoch milliseconds (UTC)

  - `attachment.sections.board.debug` (object)

  - `attachment.sections.board.description` (string)

  - `attachment.sections.board.followedByMe` (boolean)

  - `attachment.sections.board.followerCount` (integer)

  - `attachment.sections.board.imageCoverUrl` (string)

  - `attachment.sections.board.imageThumbnailUrl` (string)

  - `attachment.sections.board.images` (object)

  - `attachment.sections.board.isCollaborative` (boolean)

  - `attachment.sections.board.layout` (string)

  - `attachment.sections.board.mapId` (string)

  - `attachment.sections.board.name` (string)

  - `attachment.sections.board.pinCount` (integer)

  - `attachment.sections.board.pinThumbnailUrls` (array)

  - `attachment.sections.board.privacy` (string)

  - `attachment.sections.board.recommendationReason` (object)

  - `attachment.sections.board.url` (string)

  - `attachment.sections.board.viewerInvitation` (object)

  - `attachment.sections.board.owner` (object)

  - `attachment.sections.board.owner.username` (string)

  - `attachment.sections.createdTime` (integer)

  - `attachment.sections.permalink` (string)

  - `attachment.body` (string)

  - `attachment.footerText` (string)

  - `attachment.buttonTitle` (string)

  - `attachment.order` (integer)

  - `attachment.items` (array)

  - `attachment.items.name` (string)
    Item name

  - `attachment.items.type` (string)
    Item type

  - `attachment.items.label` (string)
    Item label

  - `attachment.items.fieldType` (string)
    Item field type

  - `attachment.items.checkConditions` (array)
    Item conditions

  - `attachment.items.value` (string)
    Item value

  - `attachment.items.additional` (object)
    Item additional details

  - `attachment.items.entityContext` (object)
    Item entity specific context

  - `attachment.items.values` (array)
    Item values

  - `attachment.items.values.key` (string)
    Value detail key

  - `attachment.items.values.label` (string)
    Value detail dispaly name

  - `attachment.items.values.metadata` (object)
    Value detail additional metadata

  - `attachment.items.values.keyType` (string)
    Value detail type of key

  - `attachment.items.values.assetType` (string)
    Value detail type of asset

  - `attachment.items.values.searchTags` (array)
    Value detail tags for searching

  - `attachment.items.values.additional` (object)
    Value detail additional details

  - `attachment.items.isComplex` (boolean)
    Specifies if item is complex

  - `attachment.items.childItems` (array)
    Child items for nested conditions

  - `attachment.id` (string)

  - `attachment.message` (string)
    Message text to display when requesting location

  - `attachment.body` (string)
    Body text of the message

  - `attachment.footerText` (string)
    Footer text of the message

  - `attachment.ctaUrl` (string)
    URL for the call-to-action button

  - `attachment.displayText` (string)
    Display text for the CTA button

  - `attachment.urlPlaceHolder` (object)
    Placeholder for URL

  - `attachment.urlType` (object)
    Unresolved type (UrlType)

  - `attachment.header` (string)
    Header of the message

  - `attachment.footer` (string)
    Footer text of the message

  - `attachment.message` (string)
    Message text to display when requesting address

  - `attachment.addressFields` (array)
    List of address fields

  - `attachment.useSavedAddresses` (boolean)
    Boolean flag to use saved addresses

  - `attachment.fieldName` (string)
    Name of the address field

  - `attachment.prefilledValuePlaceHolder` (object)
    Placeholder for prefilled value

  - `attachment.copyResponseToCustomField` (object)
    Placeholder for copying response to custom field

  - `attachment.timeslots` (array)

  - `attachment.timezone` (string)

  - `attachment.location` (object)

  - `attachment.location.name` (string)

  - `attachment.location.address` (string)

  - `attachment.location.crossStreet` (string)

  - `attachment.location.lat` (number)

  - `attachment.location.lng` (number)

  - `attachment.location.postalCode` (string)

  - `attachment.location.cc` (string)

  - `attachment.location.city` (string)

  - `attachment.location.state` (string)

  - `attachment.location.country` (string)

  - `attachment.location.distance` (number)

  - `attachment.duration` (integer)

  - `attachment.startTime` (integer)

  - `attachment.latitude` (number)

  - `attachment.longitude` (number)

  - `attachment.radius` (number)

  - `attachment.link` (string)

  - `attachment.mediaUrl` (string)

  - `attachment.previewUrl` (string)

  - `attachment.events` (array)
    Collection of events

  - `attachment.events.type` (string, required)
    Type of event

  - `attachment.events.filledForm` (object)
    Data of the form filled

  - `attachment.events.filledForm.formId` (string)
    Id of the form

  - `attachment.events.filledForm.plainFieldValues` (object)
    fields keys and values

  - `attachment.events.filledForm.subFilledForms` (object)
    subforms of current form

  - `attachment.messageTitle` (string)

  - `attachment.messageSubtitle` (string)

  - `attachment.form` (object)
    The Form with its fields

  - `attachment.form.formId` (string)

  - `attachment.form.formTitle` (string)

  - `attachment.form.repeatable` (boolean)

  - `attachment.form.minCount` (integer)

  - `attachment.form.maxCount` (integer)

  - `attachment.form.fields` (array)

  - `attachment.form.fields.id` (string)
    Id of the field

  - `attachment.form.fields.apiName` (string)
    Api Name for the field

  - `attachment.form.fields.name` (string)
    Name of the field

  - `attachment.form.fields.description` (string)
    Description of the field

  - `attachment.form.fields.type` (string)
    Type of the field

  - `attachment.form.fields.entityDefinitionId` (string)
    Id of the definition this field is a part of.

  - `attachment.form.fields.lookupType` (string)
    If the field is of type LOOKUP, this would specify which entity is the reference for lookup

  - `attachment.form.fields.parentChild` (boolean)
    If this entity is of type LOOKUP and has a parentChild relationship, the entity with the referenced value is also deleted is the referenced entity is deleted.

  - `attachment.form.fields.form` (object)
    If the field is of type FORM, its definition is stored here

  - `attachment.form.fields.multivalued` (boolean)
    Specifies if the field is multivalued or not.

  - `attachment.form.fields.mandatory` (boolean)
    Specifies if the field is mandatory or not.

  - `attachment.form.fields.controllingField` (string)
    The id of the field controlling its values, if any.

  - `attachment.form.fields.picklistValues` (array)
    Picklist values defined for the field, if any.

  - `attachment.form.fields.picklistValues.label` (string)

  - `attachment.form.fields.picklistValues.value` (string)

  - `attachment.form.fields.picklistValues.description` (string)

  - `attachment.form.fields.picklistValues.iconUrl` (string)

  - `attachment.form.fields.picklistValues.controllingFieldValues` (array)

  - `attachment.form.fields.picklistValues.standard` (string)

  - `attachment.form.fields.picklistValues.active` (boolean)

  - `attachment.form.fields.picklistValues.defaultValue` (boolean)

  - `attachment.form.fields.picklistValues.additional` (object)

  - `attachment.form.fields.picklistValues.langVsTranslatedFieldValues` (object)

  - `attachment.form.fields.defaultValue` (object)
    Default value for the field, if any.

  - `attachment.form.fields.additional` (object)
    Additional info based on type of field.

  - `attachment.form.fields.langVsTranslatedFieldValues` (object)
    Multiple Language support for field values

  - `attachment.businessPrivacyUrl` (string)

  - `attachment.fbColorTheme` (string)

  - `attachment.fbReceiverAppId` (string)

  - `attachment.postSubmitTitle` (string)

  - `attachment.postSubmitImageUrl` (string)

  - `attachment.postSubmitSubtitle` (string)

  - `attachment.disableManualResponse` (boolean)

  - `attachment.postSubmit` (object)
    non-clickable button shown after form is submitted

  - `attachment.showSubmittedContent` (boolean)

  - `attachment.showContentPostSubmit` (boolean)

  - `attachment.showSummary` (boolean)

  - `attachment.title` (string)
    Title of the feedback form

  - `attachment.subtitle` (string)
    Subtitle of the feedback form

  - `attachment.questionTitle` (string)
    Question title for the feedback form

  - `attachment.postSubmitTitle` (string)
    Title to display after submission

  - `attachment.submit` (object)
    Submit button

  - `attachment.feedbackLabels` (array)
    List of feedback labels

  - `attachment.feedbackType` (string)

  - `attachment.maxFeedbackRating` (integer)
    Maximum feedback rating

  - `attachment.feedbackVariant` (string)

  - `attachment.feedbackCommentEnabled` (boolean)
    Whether feedback comment is enabled

  - `attachment.feedbackCommentPlaceholder` (string)
    Placeholder text for feedback comment

  - `attachment.ruleId` (string)
    Rule ID to execute when feedback is submitted

  - `attachment.reverseOrder` (boolean)
    Whether to reverse the order of feedback options

  - `attachment.businessPrivacyUrl` (string)
    Business privacy URL

  - `attachment.expiresIn` (integer)
    Number of days until the feedback form expires

  - `attachment.label` (string)
    Label text

  - `attachment.reCaptchaValidated` (boolean)
    Boolean flag indicating if reCAPTCHA is validated

  - `attachment.submitted` (boolean)
    Boolean flag indicating if form is submitted

  - `attachment.cancel` (object)
    Cancel button

  - `attachment.expiryTimestamp` (integer)
    Expiry timestamp of the submit token

  - `attachment.submitTokenExpiryInSeconds` (integer)
    Submit token expiry in seconds

  - `attachment.dataValidityInSeconds` (integer)
    Data validity in seconds

  - `attachment.readTokenExpiryInSeconds` (integer)
    Read token expiry in seconds

  - `attachment.afterAccessExpiryInSeconds` (integer)
    After access expiry in seconds

  - `attachment.selectDateTitle` (string)
    Title for date selection

  - `attachment.selectTimeTitle` (string)
    Title for time selection

  - `attachment.selectDatePlaceholder` (string)
    Placeholder for date selection

  - `attachment.selectTimePlaceholder` (string)
    Placeholder for time selection

  - `attachment.submitDateTitle` (string)
    Title for submitted date

  - `attachment.submitTimeTitle` (string)
    Title for submitted time

  - `attachment.numDays` (integer)
    Number of days to show appointments

  - `attachment.offsetDays` (integer)
    Offset days from current date

  - `attachment.postSubmit` (object)
    Post-submit button

  - `attachment.slotDefinitionConfigId` (string)
    Slot definition configuration ID

  - `attachment.showSubmittedContent` (boolean)
    Boolean flag to show submitted content

  - `attachment.params` (object)
    Additional parameters

  - `attachment.selectedDate` (integer)
    Selected date timestamp

  - `attachment.dateFormat` (string)
    Date format string

  - `attachment.noSlotsAvailableLabel` (string)
    Label when no slots are available

  - `attachment.fromFirstAvailableSlot` (boolean)
    Boolean flag to start from first available slot

  - `attachment.version` (integer)
    Version of appointment template

  - `attachment.title` (string)
    Title of the survey

  - `attachment.description` (string)
    Description of the survey

  - `attachment.name` (string)
    Name of the survey

  - `attachment.surveyButton` (object)
    Button to open the survey

  - `attachment.expireAt` (integer)
    Expiration timestamp

  - `attachment.autoOpen` (boolean)
    Boolean flag to auto-open the survey

  - `attachment.opened` (boolean)
    Boolean flag indicating if survey is opened

  - `attachment.commands` (array)

  - `attachment.commands.type` (string)

  - `attachment.commands.from` (string)

  - `attachment.commands.to` (string)

  - `attachment.commands.duration` (integer)

  - `attachment.commands.startTime` (integer)

  - `attachment.commands.callConnected` (boolean)

  - `attachment.commands.callDirection` (string)

  - `attachment.commands.contactId` (string)

  - `attachment.commands.authChannelTypeAndUserId` (string)

  - `attachment.commands.endTime` (integer)

  - `attachment.commands.text` (string)

  - `attachment.commands.interactionId` (string)

  - `attachment.commands.language` (string)

  - `attachment.commands.topics` (array)

  - `attachment.commands.callStartTime` (integer)

  - `attachment.commands.recordingOffset` (integer)

  - `attachment.commands.lastPacketReceivedTime` (integer)

  - `attachment.commands.vadResponseTime` (integer)

  - `attachment.commands.asrResponseTime` (integer)

  - `attachment.commands.convEventReceivedTime` (integer)

  - `attachment.commands.recordingId` (string)

  - `attachment.commands.secure` (boolean)

  - `attachment.commands.loops` (integer)

  - `attachment.commands.languageCode` (string)

  - `attachment.commands.audio` (string)

  - `attachment.commands.title` (string)

  - `attachment.commands.audioTranscript` (string)

  - `attachment.commands.dtmf` (string)

  - `attachment.commands.entityId` (string)

  - `attachment.commands.maskedData` (string)

  - `attachment.commands.expiryTimestamp` (integer)

  - `attachment.commands.viewDetailsUrl` (string)

  - `attachment.commands.httpMethod` (string)

  - `attachment.commands.httpHeaders` (object)

  - `attachment.commands.numDigits` (integer)

  - `attachment.commands.finishOnKey` (string)

  - `attachment.commands.voiceCommands` (array)

  - `attachment.commands.accessibleToAgent` (boolean)

  - `attachment.commands.hideFromAgent` (boolean)

  - `attachment.commands.recordingDuration` (number)

  - `attachment.commands.recordingUrl` (string)

  - `attachment.commands.transcript` (string)

  - `attachment.commands.participantType` (string)

  - `attachment.commands.contentType` (string)

  - `attachment.commands.privateRecording` (boolean)

  - `attachment.commands.privateUrl` (string)

  - `attachment.commands.encryptedRecording` (boolean)

  - `attachment.commands.encryptedUrl` (string)

  - `attachment.commands.downloadDisabled` (boolean)

  - `attachment.commands.botRecording` (boolean)

  - `attachment.commands.recordingPath` (string)

  - `attachment.commands.caller` (string)

  - `attachment.commands.action` (string)

  - `attachment.commands.reason` (string)

  - `attachment.commands.status` (string)

  - `attachment.commands.actionTime` (integer)

  - `attachment.commands.creationTime` (integer)

  - `attachment.commands.requesterCaller` (string)

  - `attachment.commands.assignmentRejectionReason` (string)

  - `attachment.commands.disconnectionReason` (string)

  - `attachment.commands.callFailureReason` (string)

  - `attachment.commands.agent` (string)

  - `attachment.commands.transferType` (string)

  - `attachment.commands.assignee` (object)
    Assignment details of Workflow on message/case

  - `attachment.commands.assignee.assigneeId` (string)
    Describes the id of assignee

  - `attachment.commands.assignee.assigneeType` (string)
    Describes the assignee type. e.g. USER, BOT

  - `attachment.commands.assignee.assignedById` (integer)
    Describes the assigned by user id.

  - `attachment.commands.assignee.assignmentTime` (integer)
    Assignment time.

  - `attachment.commands.phoneNumber` (string)

  - `attachment.commands.processId` (string)

  - `attachment.commands.message` (string)

  - `attachment.commands.fallbackIVR` (string)

  - `attachment.commands.baseUrl` (string)

  - `attachment.commands.method` (string)

  - `attachment.commands.maxDuration` (integer)

  - `attachment.commands.silenceTimeout` (integer)

  - `attachment.commands.playBeep` (boolean)

  - `attachment.commands.transcribe` (boolean)

  - `attachment.commands.pitch` (string)

  - `attachment.commands.speechRate` (string)

  - `attachment.commands.energy` (string)

  - `attachment.commands.inviteType` (string)

  - `attachment.commands.time` (string)

  - `attachment.commands.format` (string)

  - `attachment.commands.formatDetails` (object)

  - `attachment.wabaTemplateId` (integer)
    template ID

  - `attachment.namespace` (string)
    namespace for template

  - `attachment.templateName` (string)
    template name

  - `attachment.wabaId` (string)
    Whatsapp account Id.

  - `attachment.elementName` (string)
    the name of the template.

  - `attachment.category` (string)
    category of the template.

  - `attachment.langCode` (string)
    language code.

  - `attachment.buttons` (array)
    List of buttons on the carousel card.

  - `attachment.wabaTemplateStatus` (string)
    status of the template.

  - `attachment.rejectedReason` (string)
    reason for rejecting the template.

  - `attachment.message` (string)
    Header Description Message.

  - `attachment.footer` (string)
    details about the content of the Footer.

  - `attachment.header` (object)
    Details about Header object.

  - `attachment.allowCategoryChange` (boolean)
    flag for allow category change.

  - `attachment.placeholders` (array)
    List of placeholders used in the carousel card.

  - `attachment.example` (array)
    Examples.

  - `attachment.carouselCards` (array)
    Carousel Cards

  - `attachment.additionalDetails` (object)
    Additional Details

  - `attachment.headerType` (object)
    Type of header.

  - `attachment.body` (string)
    Body of the carousel card.

  - `attachment.label` (object)
    Unresolved type (finalString)

  - `attachment.name` (string)

  - `attachment.text` (string)

  - `attachment.elementList` (array)

  - `attachment.elementList.title` (string)

  - `attachment.elementList.url` (string)

  - `attachment.elementList.elementList` (array)

  - `attachment.elementList.attachedAssets` (array)

  - `attachment.elementList.quantity` (integer)

  - `attachment.elementList.price` (integer)

  - `attachment.elementList.currency` (string)

  - `attachment.elementList.type` (string)

  - `attachment.elementList.actionType` (string)

  - `attachment.buttons` (array)

  - `attachment.description` (string)
    Description for the Product

  - `attachment.footer` (string)

  - `attachment.productContentSummary` (object)
    ProductContentSummary for the product

  - `attachment.productList` (array)
    list of product detail

  - `attachment.totalItems` (integer)
    total items of product

  - `attachment.totalPrice` (number)
    total price of product

  - `attachment.currency` (string)
    currency type

  - `attachment.catalogId` (string)

  - `attachment.sourceCatalogId` (string)

  - `attachment.itemUrl` (string)

  - `attachment.retailerId` (string)

  - `attachment.price` (string)

  - `attachment.quantity` (integer)

  - `attachment.title` (string)
    title of the POLL

  - `attachment.content` (string)
    content of the POLL

  - `attachment.pollsDetails` (object)
    details of the POLL like question, choices etc

  - `attachment.pollsDetails.anonymous` (boolean)

  - `attachment.pollsDetails.pollId` (string)

  - `attachment.pollsDetails.ownerId` (string)

  - `attachment.pollsDetails.pollQuestion` (string)

  - `attachment.pollsDetails.duration` (string)

  - `attachment.pollsDetails.pollOptions` (array)

  - `attachment.pollsDetails.pollOptions.text` (string)

  - `attachment.pollsDetails.pollOptions.answerId` (string)

  - `attachment.pollsDetails.pollOptions.rating` (number)

  - `attachment.pollsDetails.pollOptions.votes` (integer)

  - `attachment.pollsDetails.pollOptions.percentage` (number)

  - `attachment.pollsDetails.totalVotes` (integer)

  - `attachment.pollsDetails.expiryTime` (string)

  - `attachment.visibility` (object)
    Visibility of Poll

  - `attachment.visibility.globallyVisible` (boolean)
    True if Asset is globally visible

  - `attachment.visibility.visibilityConfig` (array)
    Config to share the asset

  - `attachment.value` (object)
    Unresolved type (finalString)

  - `attachment.anonymous` (boolean)
    flag to determine if poll is anonymous

  - `attachment.pollQuestion` (string)
    question of the poll

  - `attachment.duration` (string)
    time duration of the poll

  - `attachment.pollOptions` (array)
    list of options of the poll

  - `attachment.text` (string)
    option of the poll

  - `attachment.votes` (integer)
    number of votes against the option

  - `attachment.title` (string)
    title of the album

  - `attachment.existingAlbumId` (string)
    id of the already existing album

  - `attachment.threads` (array)
    Thread List

  - `attachment.threads.title` (string)
    Title of the message.

  - `attachment.threads.titleHash` (string)
    Hashed Title of the message.

  - `attachment.threads.text` (string)
    Text content of the message.

  - `attachment.threads.textHash` (string)
    Hashed Text content of the message.

  - `attachment.threads.richText` (string)
    Rich Text content of the message.

  - `attachment.threads.postbackPayload` (string)
    Postback Payload of the button selected.

  - `attachment.threads.attachment` (any)
    Attachment of the message to be published.

  - `attachment.threads.templateId` (string)
    Content template ID

  - `attachment.threads.isRichText` (boolean)
    Is the provided text a rich text

  - `lastModifiedById` (integer)
    Last Modified by for the asset

  - `reportingStats` (object)
    Reporting stats of the asset

## Response 400:

  - `400` (unknown)
    Bad request

## Response 400 fields (application/json):

  - `data` (object)

  - `errors` (array)

  - `errors.id` (string, required)
    24-character hex ObjectId

  - `errors.code` (integer, required)

  - `errors.message` (string, required)
    Dotted error key (e.g. account.not.found)

  - `metadata` (object)

## Response 401:

  - `401` (unknown)
    Missing or invalid authentication

## Response 401 fields (application/json):

  - `data` (object)

  - `errors` (array)

  - `errors.id` (string, required)
    24-character hex ObjectId

  - `errors.code` (integer, required)

  - `errors.message` (string, required)
    Dotted error key (e.g. account.not.found)

  - `metadata` (object)

## Response 403:

  - `403` (unknown)
    Insufficient permissions

## Response 403 fields (application/json):

  - `data` (object)

  - `errors` (array)

  - `errors.id` (string, required)
    24-character hex ObjectId

  - `errors.code` (integer, required)

  - `errors.message` (string, required)
    Dotted error key (e.g. account.not.found)

  - `metadata` (object)

## Response 404:

  - `404` (unknown)
    Resource not found

## Response 404 fields (application/json):

  - `data` (object)

  - `errors` (array)

  - `errors.id` (string, required)
    24-character hex ObjectId

  - `errors.code` (integer, required)

  - `errors.message` (string, required)
    Dotted error key (e.g. account.not.found)

  - `metadata` (object)