{"note":"OpenAPI conversion -- returning structured metadata","name":"salesforce-marketing-cloud","description":"Marketing Cloud REST API","version":"1.0.0","base_url":"https://www.exacttargetapis.com","endpoints":29,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Marketing Cloud REST API\n@base https://www.exacttargetapis.com\n@version 1.0.0\n@endpoints 29\n@hint download_for_search\n@toc asset(4), hub(3), messaging(22)\n\n@group asset\n@endpoint GET /asset/v1/content/assets/{id}\n@desc getAssetById\n@required {id: any # The ID of the asset}\n@returns(200) A single asset\n@errors {400: Bad request, 403: Permission error}\n\n@endpoint PATCH /asset/v1/content/assets/{id}\n@desc partiallyUpdateAssetById\n@required {id: any # The ID of the asset to update, body: map # JSON Parameters}\n@returns(200) A single asset\n@errors {400: Bad request, 403: Permission error}\n\n@endpoint DELETE /asset/v1/content/assets/{id}\n@desc deleteAssetById\n@required {id: any # The ID of the asset to delete}\n@errors {400: Bad request, 403: Permission error}\n\n@endpoint POST /asset/v1/content/assets\n@desc createAsset\n@required {body: map # JSON Parameters}\n@returns(200) A single asset\n@errors {400: Bad request, 403: Permission error}\n\n@endgroup\n\n@group hub\n@endpoint POST /hub/v1/campaigns\n@desc createCampaign\n@required {body: map # JSON Parameters}\n@returns(200) A single campaign\n\n@endpoint GET /hub/v1/campaigns/{id}\n@desc getCampaignById\n@required {id: any # Campaign ID}\n@returns(200) A single campaign\n\n@endpoint DELETE /hub/v1/campaigns/{id}\n@desc deleteCampaignById\n@required {id: any # The ID of the campaign to delete}\n@errors {400: Bad request, 403: Permission error}\n\n@endgroup\n\n@group messaging\n@endpoint POST /messaging/v1/email/definitions/\n@desc createEmailDefinition\n@required {body: map # JSON Parameters}\n@returns(201) A single definition for an email\n@errors {400: Bad request, 403: Permission error, 409: Conflict, 500: Server Error}\n\n@endpoint GET /messaging/v1/email/definitions/\n@desc getEmailDefinitions\n@optional {$filter: any # Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq., $pageSize: any # Number of definitions, which are array elements, to return per paged response., $page: any # Page number to return., $orderBy: any # Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status.}\n@returns(200) Email definitions successfully retrieved\n@errors {400: Bad request, 403: Permission error, 500: Server Error}\n\n@endpoint DELETE /messaging/v1/email/definitions/{definitionKey}\n@desc deleteEmailDefinition\n@required {definitionKey: any # Unique identifier of the definition to delete}\n@returns(200) Definition of email successfully deleted\n@errors {400: Bad request, 403: Permission error, 404: Not found, 500: Server Error}\n\n@endpoint PATCH /messaging/v1/email/definitions/{definitionKey}\n@desc partiallyUpdateEmailDefinition\n@required {definitionKey: any # Unique identifier of the definition., body: map # JSON Parameters}\n@returns(200) A single definition for an email\n@errors {400: Bad request, 403: Permission error, 500: Server Error}\n\n@endpoint GET /messaging/v1/email/definitions/{definitionKey}\n@desc getEmailDefinition\n@required {definitionKey: any # Unique identifier of the definition to get}\n@returns(200) Definition of email successfully retrieved\n@errors {400: Bad request, 403: Permission error, 404: Not found, 500: Server Error}\n\n@endpoint GET /messaging/v1/email/definitions/{definitionKey}/queue\n@desc getQueueMetricsForEmailDefinition\n@required {definitionKey: any # Unique identifier of the email definition}\n@returns(200) Metrics for the messages of an email definition\n@errors {400: Bad request, 403: Permission error}\n\n@endpoint DELETE /messaging/v1/email/definitions/{definitionKey}/queue\n@desc deleteQueuedMessagesForEmailDefinition\n@required {definitionKey: any # Unique identifier of the email definition}\n@returns(200) Queue for email defintion successfully deleted\n@errors {400: Bad request, 403: Permission error}\n\n@endpoint POST /messaging/v1/email/messages/\n@desc sendEmailToMultipleRecipients\n@required {body: map # JSON Parameters}\n@returns(202) Accepted\n@errors {400: Bad request, 403: Permission error, 500: Server Error}\n\n@endpoint GET /messaging/v1/email/messages/\n@desc getEmailsNotSentToRecipients\n@required {type: any # Only notSent is supported.}\n@optional {$pageSize: any # Number of messageKeys (array elements) to return per response page., lastEventId: any # Event ID from which you want the response to start. To obtain the initial event ID, submit a request without a lastEventId. The events in the response are listed top to bottom from oldest to newest.}\n@returns(200)\n@errors {400: Bad request, 401: Unauthorized, 500: Server Error}\n\n@endpoint GET /messaging/v1/email/messages/{messageKey}\n@desc getEmailSendStatusForRecipient\n@required {messageKey: any # Unique identifier to track message send status. You must provide it in singleton requests using the recipient attribute. To provide it in batch requests, use the recipients array attribute. If you don’t provide the message key for recipients, it’s generated in the response.}\n@returns(200) Email send status for recipient succesfully retrieved.\n@errors {400: Bad request, 401: Unauthorized, 500: Server Error}\n\n@endpoint POST /messaging/v1/email/messages/{messageKey}\n@desc sendEmailToSingleRecipient\n@required {messageKey: any # Unique identifier used to track message status. Can be automatically created when you create a message or provided as part of the request. Each recipient in a request must have a unique messageKey. If you use a duplicate messageKey in the same send request, the message is rejected., body: map # JSON Parameters}\n@returns(202)\n@errors {400: Bad request, 401: Unauthorized, 403: Permission error, 500: Server Error}\n\n@endpoint GET /messaging/v1/sms/definitions/{definitionKey}\n@desc getSmsDefinition\n@required {definitionKey: any # Unique identifier of the definition to get}\n@returns(200) Definition of SMS successfully retrieved\n@errors {400: Bad request, 403: Permission error, 404: Not found, 500: Server Error}\n\n@endpoint PATCH /messaging/v1/sms/definitions/{definitionKey}\n@desc partiallyUpdateSmsDefinition\n@required {definitionKey: any # Unique identifier of the definition., body: map # JSON Parameters}\n@returns(200) A single definition for an SMS\n@errors {400: Bad request, 403: Permission error, 500: Server Error}\n\n@endpoint DELETE /messaging/v1/sms/definitions/{definitionKey}\n@desc deleteSmsDefinition\n@required {definitionKey: any # Unique identifier of the definition to delete}\n@returns(200) Definition of SMS successfully deleted\n@errors {400: Bad request, 403: Permission error, 404: Not found, 500: Server Error}\n\n@endpoint POST /messaging/v1/sms/definitions\n@desc createSmsDefinition\n@required {body: map # JSON Parameters}\n@returns(201) A single definition for an sms\n@errors {400: Bad request, 403: Permission error, 409: Conflict, 500: Server Error}\n\n@endpoint GET /messaging/v1/sms/definitions\n@desc getSmsDefinitions\n@optional {$filter: any # Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq., $pageSize: any # Number of definitions, which are array elements, to return per paged response., $page: any # Page number to return., $orderBy: any # Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status.}\n@returns(200) SMS definitions successfully retrieved\n@errors {400: Bad request, 403: Permission error, 500: Server Error}\n\n@endpoint GET /messaging/v1/sms/definitions/{definitionKey}/queue\n@desc getQueueMetricsForSmsDefinition\n@required {definitionKey: any # Unique identifier of the SMS definition}\n@returns(200) Metrics for the messages of an SMS definition\n@errors {400: Bad request, 403: Permission error}\n\n@endpoint DELETE /messaging/v1/sms/definitions/{definitionKey}/queue\n@desc deleteQueuedMessagesForSmsDefinition\n@required {definitionKey: any # Unique identifier of the SMS definition}\n@returns(200) Queue for SMS defintion successfully deleted\n@errors {400: Bad request, 403: Permission error}\n\n@endpoint POST /messaging/v1/sms/messages/\n@desc sendSmsToMultipleRecipients\n@required {body: map # JSON Parameters}\n@returns(202) Accepted\n@errors {400: Bad request, 403: Permission error, 500: Server Error}\n\n@endpoint GET /messaging/v1/sms/messages/\n@desc getSMSsNotSentToRecipients\n@required {type: any # Only notSent is supported.}\n@optional {$pageSize: any # Number of messageKeys (array elements) to return per response page., lastEventId: any # Event ID from which you want the response to start. To obtain the initial event ID, submit a request without a lastEventId. The events in the response are listed top to bottom from oldest to newest.}\n@returns(200)\n@errors {400: Bad request, 401: Unauthorized, 500: Server Error}\n\n@endpoint POST /messaging/v1/sms/messages/{messageKey}\n@desc sendSmsToSingleRecipient\n@required {messageKey: any # Unique identifier of the definition used to track message status. The messageKey can be created automatically when you create a message, or you can provide it as part of the request. Each recipient in a request must have a unique messageKey. If you use a duplicate messageKey in the same send request, the message is rejected., body: map # JSON Parameters}\n@returns(202)\n@errors {400: Bad request, 401: Unauthorized, 403: Permission error, 500: Server Error}\n\n@endpoint GET /messaging/v1/sms/messages/{messageKey}\n@desc getSmsSendStatusForRecipient\n@required {messageKey: any # Unique identifier to track message send status. You must provide it in singleton requests using the recipient attribute. To provide message key in batch requests, use the recipients array attribute. If you don’t provide the message key for recipients, it’s generated in the response.}\n@returns(200) SMS send status for recipient succesfully retrieved.\n@errors {400: Bad request, 401: Unauthorized, 500: Server Error}\n\n@endgroup\n\n@end\n"}