Sign in

v1

latestSwagger 2.02026-07-17101735.8 KB
TollFreeVerification - CampaignBriefAttachment

Creates or updates an attachment on a Campaign Brief.

put/tollfreeVerification/countries/{countryCode}/campaignBriefs/{campaignBriefId}/attachments/{attachmentId}

Path parameters

countryCodestring required

Country Code Id. Must be a valid country code

campaignBriefIdstring uuid required

Campaign Brief Id. Must be a valid GUID

attachmentIdstring uuid required

Attachment Id. Must be a valid GUID

Query parameters

api-versionstring required

Version of API to invoke

Request body

idstring uuid required

Campaign Brief Attachment Id.

type'optInSmsKeyword' | 'optInIVR' | 'optInPointOfSale' | 'optInWebsite' | 'optInPaperForm' | 'optInOther' | 'optInDescription' required

Attachment type describing the purpose of the attachment e.g. 'callToAction', 'termsOfService'

fileNamestring required

The name of the file being attached e.g. 'myFile01'

fileSizeInBytesinteger

File size in bytes.

fileType'png' | 'jpg' | 'jpeg' | 'pdf' required

The type of file being attached e.g. 'pdf', 'jpg', 'png'

fileContentBase64string required

File content as base 64 encoded string

Response

Success

idstring uuid required

Campaign Brief Attachment Id.

type'optInSmsKeyword' | 'optInIVR' | 'optInPointOfSale' | 'optInWebsite' | 'optInPaperForm' | 'optInOther' | 'optInDescription' required

Attachment type describing the purpose of the attachment e.g. 'callToAction', 'termsOfService'

fileNamestring required

The name of the file being attached e.g. 'myFile01'

fileSizeInBytesinteger

File size in bytes.

fileType'png' | 'jpg' | 'jpeg' | 'pdf' required

The type of file being attached e.g. 'pdf', 'jpg', 'png'

fileContentBase64string required

File content as base 64 encoded string