Skip to main content

Get Detailed Task Status

GET 

/bulkCreation/:taskId/detailedStatus

Get detailed information about the status of a bulk creation task.

Request

Path Parameters

    taskId Taskidrequired

Query Parameters

    recordsPerPage any
    page any

Responses

200: Successful Response

Schema

    meta

    object

    required

    page Pagerequired
    recordsPerPage Recordsperpagerequired
    totalPages Totalpagesrequired
    totalRecords Totalrecordsrequired

    records

    object[]

    required

  • Array [

  • taskId Taskidrequired

    The ID of the task associated with bulk Sole Proprietor brand and campaign creation.

    referenceId Referenceidrequired

    A user generated unique identifier that keeps track of sole proprietor brand/campaign combinations submitted during bulk creation.

    brand

    object[]

    required

    The status of the individual brand submitted via bulk creation.

  • Array [

  • displayName Displaynamerequired

    The display name of the brand submitted via bulk creation.

    status object

    An enumeration.

    brandId Brandid

    The ID of the brand created via bulk creation. This brand will only have a brandId after the brand has been created.

    created_at date-time

    The date and time that the brand was created.

    error Error

    Errors related to a brand creation failure.

  • ]

  • campaign

    object[]

    required

    The status of the individual campaign submitted via bulk creation.

  • Array [

  • description Descriptionrequired

    The campaign description.

    status object

    An enumeration.

    campaignId Campaignid

    The ID of the campaign created via bulk creation. This campaign will only have a campaignId after the campaign has been created.

    created_at date-time

    The date and time that the campaign was created.

    error Error

    Errors related to a campaign creation failure.

  • ]

  • phoneNumbers

    object[]

    required

  • Array [

  • phoneNumber Phonenumberrequired

    A phone number that is intended to be linked to a campaign.

    status object

    An enumeration.

    assigned_at date-time

    The date and time that the this phone number was assigned.

    error Error

    Errors related to an individual phone number assignment.

  • ]

  • ]

422: Validation Error

Schema

    detail

    object[]

  • Array [

  • loc

    object[]

    required

  • Array [

  • anyOf

    string

  • ]

  • msg Messagerequired
    type Error Typerequired
  • ]

Loading...