Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateUploadJob

Creates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key.

Request Syntax


POST /domains/DomainName/upload-jobs HTTP/1.1
Content-type: application/json

{
   "DataExpiry": number,
   "DisplayName": "string",
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "UniqueKey": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain. Domain should be exists for the upload job to be created.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

DataExpiry

The expiry duration for the profiles ingested with the job. If not provided, the system default of 2 weeks is used.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1098.

Required: No

DisplayName

The unique name of the upload job. Could be a file name to identify the upload job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Fields

The mapping between CSV Columns and Profile Object attributes. A map of the name and ObjectType field.

Type: String to ObjectTypeField object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: ^[a-zA-Z0-9_.-]+$

Required: Yes

UniqueKey

The unique key columns for de-duping the profiles used to map data to the profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "JobId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

JobId

The unique identifier for the created upload job.

Type: String

Pattern: [a-f0-9]{32}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429