v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
User Campaign

Get User Campaign

Given a campaign id, it returns all attributes of the user campaign

get/api/v2/core/user-campaigns/{userCampaignId}

Path parameters

userCampaignIdstring required

Id of user campaign in Eightfold

Query parameters

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

createdAtinteger nullable

Timestamp when this user campaign was created

idstring nullable

Id associated with the user campaign

subjectstring nullable

Subject of this user campaign

statusstring nullable

Status of this user campaign

namestring nullable

Name of the user campaign

userIdstring nullable

User who initiated this user campaign

replyTostring nullable

Reply To as set in the email envelope of this user campaign

emailFromNamestring nullable

Name of the sender in email envelope of this user campaign

updatedAtinteger nullable

Timestamp when this user campaign was updated

emailFromAddressstring nullable

Email from address of the email envelope for this user campaign