Jump to

• Request
• Response
• Examples

Upload contact sync action data

post

/api/bulk/2.0/contacts/syncActions/{id}/data

Uploads contact sync action data.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer

Body ()

Root Schema : ContactSyncActionOperationData

Type: array

Title: ContactSyncActionOperationData

Show Source

• Array of: object ContactSyncActionOperationDataItem
  Title: ContactSyncActionOperationDataItem

{
    "title":"ContactSyncActionOperationData",
    "type":"array",
    "items":{
        "title":"ContactSyncActionOperationDataItem",
        "type":"object",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : ContactSyncActionOperationDataItem

Type: object

Title: ContactSyncActionOperationDataItem

Show Source

• Array of: string

{
    "title":"ContactSyncActionOperationDataItem",
    "type":"object",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success.

Body ()

Root Schema : ContactSyncActionOperationDataResponse

Type: object

Title: ContactSyncActionOperationDataResponse

Show Source

• callbackUrl: string
  Title: callbackUrl
• createdAt: string(date-time)
  Title: createdAt
• createdBy: string
  Title: createdBy
• status: string
  Title: SyncStatusType

  Default Value: pending

  Allowed Values: [ "pending", "active", "success", "warning", "error" ]
• syncedInstanceUri: string
  Title: syncedInstanceUri
• syncEndedAt: string(date-time)
  Title: syncEndedAt
• syncStartedAt: string(date-time)
  Title: syncStartedAt
• uri: string
  Title: uri

{
    "title":"ContactSyncActionOperationDataResponse",
    "description":"",
    "properties":{
        "callbackUrl":{
            "title":"callbackUrl",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "status":{
            "$ref":"#/definitions/SyncStatusType"
        },
        "syncedInstanceUri":{
            "title":"syncedInstanceUri",
            "description":"",
            "type":"string"
        },
        "syncEndedAt":{
            "format":"date-time",
            "title":"syncEndedAt",
            "description":"",
            "type":"string"
        },
        "syncStartedAt":{
            "format":"date-time",
            "title":"syncStartedAt",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

204 Response

No content.

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

Upload the contact sync action data with a sync action id = 1, where isSyncTriggeredOnImport = false on the sync action definition:

POST /contacts/syncActions/1/data
Content-Type: application/json 
			

Request body:

[{
    "Id": "1"
}, {
    "Id": "3"
}]
			

Response:

204 No Content

			

Back to Top