OBJECT

Mutation

link GraphQL Schema definition

1type Mutation {
2
3# Arguments
4# id: Freelance Project Id
5acceptFreelanceProjectProposal(id: Int!): FreelanceProject
6
7# Accepts an invitation for a user
8acceptInvitation(id: Int!): Int
9
10# Add a file attachment to the specific message on behalf of the authenticated
11# user.
12#
13# Arguments
14# messageId: Message Id (required if `threadId` is null)
15# params: The information about file attachment
16# threadId: Thread Id (required if `messageId` is null)
17addFileAttachmentToMessage(
18messageId: Int,
19params: CreateInboxFileAttachmentParams!,
20threadId: Int
21): AddInboxFileAttachmentResponse
22
23# Add a job applicant to job shortlist on behalf of the authenticated user.
24#
25# Arguments
26# applicantId: Applicant Id
27# jobId: Job Id
28addToShortlist(applicantId: Int!, jobId: Int!): ApplicantShortlistResponse
29
30# Arguments
31# id: Job Id
32# message: Message sent with job application
33applyToJob(id: Int!, message: String): ApplyToJobResponse
34
35# Archive up to 20 threads. A list of successfully archived thread ids is
36# returned.
37archiveInboxThreads(threadIds: [String!]!): [String]
38
39# Block another user
40blockUser(
41blockeeAdobeId: String,
42blockeeUserId: Int,
43blockeeUsername: String
44): User
45
46# Sets the price of the subscription for the authenticated user
47cacheSubscriptionPrice(price: Int!): CachedSubscriptionPrice
48
49# Cancel a freelance project
50#
51# Arguments
52# id: Freelance Project Id
53cancelFreelanceProjectProposal(
54id: Int!,
55message: String
56): FreelanceProject
57
58cloneProject(id: Int!): CloneProjectResponse
59
60# check and connect a user nft wallet if not connected already
61connectNFTWalletForUser: WalletConnection
62
63# Create a new freelance project
64createFreelanceProject(
65params: CreateFreelanceProjectParams!
66): FreelanceProject
67
68# Create a new freelance service
69createFreelanceService(
70params: CreateFreelanceServiceParams!
71): CreateFreelanceServiceResponse
72
73# Create an inbox message
74createInboxMessage(
75message: String!,
76storySegmentId: Int,
77threadId: String!,
78type: InboxThreadMessageType
79): InboxThreadMessage
80
81# Create an inbox thread or add message to an existing thread
82#
83# Arguments
84# signUpOnSend: When set to true, signup will be attempted for
85# the user if they are not a member of Behance
86createInboxThread(
87freelanceServiceInquiry: FreelanceServiceInquiryParams,
88hireMeData: CreateInboxHireMeDataParams,
89message: String!,
90recipients: Recipients!,
91signUpOnSend: Boolean,
92storySegmentId: Int,
93type: InboxThreadMessageType
94): InboxThread
95
96createJob(params: CreateJobParams!): CreateJobResponse
97
98createProjectComment(
99comment: ProjectCommentInput!,
100projectId: Int!
101): CreateProjectCommentResponse
102
103# Create a setup intent for a subscriber
104createSetupIntent: PaymentSetupIntent
105
106# Create a Source File
107createSourceFile(params: CreateSourceFileParams!): SourceFile
108
109# Create a Stripe Account for a creator
110createStripeAccount: StripeAccount
111
112# Create a Stripe Subscription Product for a creator
113createSubscriptionProduct(
114currency: String!,
115unitAmount: Int!
116): SubscriptionProduct
117
118createTag(category: TagCategory!, title: Title!): Tag
119
120# Decline a payment for freelance project
121declineFreelancePayment(message: String!, paymentId: Int!): FreelancePayment
122
123# Arguments
124# originMessageId: The message id that originated the creation of
125# this project
126declineFreelanceProjectInquiry(
127message: String!,
128originMessageId: String!
129): InboxThreadMessage
130
131# Decline a freelance project proposal
132#
133# Arguments
134# id: Freelance Project Id
135declineFreelanceProjectProposal(
136id: Int!,
137message: String!
138): FreelanceProject
139
140# Declines an invitation for a user
141declineInvitation(id: Int!): Int
142
143deleteCreatorSubscription(
144contentPrivacy: PremiumContentPrivacy!
145): SubscriptionProduct
146
147# Delete a freelance service
148#
149# Arguments
150# id: Freelance Service Id
151deleteFreelanceService(id: Int!): DeleteFreelanceServiceResponse
152
153# Delete an inbox thread
154deleteInboxThread(threadId: String!): String
155
156# Delete up to 20 threads. A list of successfully deleted thread ids is returned.
157deleteInboxThreads(threadIds: [String!]!): [String]
158
159# Delete a job on behalf of the authenticated user.
160#
161# Arguments
162# id: Job Id
163deleteJob(id: Int!): DeleteJobResponse
164
165# delete a user avatar image
166deleteProfileAvatar: Viewer
167
168# delete a user profile banner image
169deleteProfileBanner: Viewer
170
171# Deletes a project
172deleteProject(id: Int!): Int
173
174# Delete a project comment on behalf of the authenticated user.
175#
176# Arguments
177# id: A project comment id
178deleteProjectComment(id: Int!): DeleteProjectCommentResponse
179
180# Delete a Source File
181deleteSourceFile(sourceFileId: Int!): DeleteSourceFileResponse
182
183disconnectNFTWalletForUserByAddress(
184address: String!
185): WalletConnection
186
187# Edit an existing freelance service
188#
189# Arguments
190# id: Freelance Service Id
191editFreelanceService(
192id: Int!,
193params: CreateFreelanceServiceParams!
194): EditFreelanceServiceResponse
195
196# Specify a project to exclude from the profile (Only supported for premium
197# projects)
198excludePremiumProjectFromProfile(id: Int!): Project
199
200# Follows the specified gallery for the logged in user
201followGallery(slug: String!): FollowGalleryResponse
202
203# Follows the specified gallery subcategory for the logged in user
204followGallerySubcategory(
205parentSlug: String!,
206slug: String!
207): FollowSubcategoryResponse
208
209# Follows the specified tag for the logged in user
210followTag(id: Int!): Int
211
212# Follows the specified team for the logged in user
213followTeam(id: Int!): Team
214
215# Follows a user
216followUser(id: Int!): FollowUserResponse
217
218hideNftsByWalletAddress(address: String!): User
219
220# check and import a user nft wallet if not imported already
221importNFTWalletForUser: User
222
223# Specify that a project can be shown on a profile (Only supported for premium
224# projects)
225includePremiumProjectInProfile(id: Int!): Project
226
227joinMeeting(threadId: String!): ChimeMeeting
228
229makeFreelancePayment(
230paymentId: Int!,
231paymentMethodId: String!
232): FreelancePayment
233
234# Make multiple livestreams premium
235makeLivestreamsPremium(livestreamVideoIds: [Int!]!): [UserLivestream]!
236
237# Make multiple projects premium
238makeProjectsPremium(projectIds: [Int!]!): [Project]!
239
240makeSourceFilePurchase(
241paymentMethodId: String!,
242sourceFileId: Int!
243): SourceFilePurchase
244
245# Mark Adobe Video as viewed
246markAdobeVideoAsViewed(video_id: VideoId!): AdobeLiveVideo
247
248markAllNotificationsAsRead: Boolean
249
250# Mark multiple threads as read
251markInboxThreadsAsRead(threadIds: [String!]!): [InboxThread!]
252
253# Mark inquiry notifications as read for the logged in user
254markInquiryNotificationsAsRead: Boolean!
255
256markNotificationsAsRead(notification_ids: [Int]!): Boolean
257
258# Mute the specified tag for the logged in user
259muteTag(id: Int!): Int
260
261# Pin a project to the subscription overview. Unpins already pinned project.
262pinSubscriptionProject(projectId: Int!): Project
263
264# Remove a file attachment from an inbox message
265removeFileAttachment(fileAssetId: String!): String
266
267# Remove a job applicant from a job shortlist on behalf of the authenticated user.
268#
269# Arguments
270# applicantId: Applicant Id
271# jobId: Job Id
272removeFromShortlist(applicantId: Int!, jobId: Int!): ApplicantShortlistResponse
273
274# Remove an inbox message and all associated file attachments from a thread by
275# message id. Returns the message id that was deleted.
276removeInboxMessage(messageId: Int!): Int!
277
278# Removes a user nft project along with all the assets
279removeNFTProjectForUser: WalletConnection
280
281# Remove a saved job on behalf of the authenticated user.
282#
283# Arguments
284# id: Job Id
285removeSavedJob(id: Int!): RemoveSavedJobResponse
286
287# Remove a user's specified Single Use
288removeUserFlag(flag: String!): UserFlag
289
290# Reorder an existing freelance service
291#
292# Arguments
293# afterId: The id of the freelance service that the specified
294# service will be moved after. Not specifying an after id will set the service as
295# the first item.
296# id: Freelance Service Id
297reorderFreelanceService(afterId: Int, id: Int!): EditFreelanceServiceResponse
298
299# Reorders the profile projects for a user
300reorderProfileProjects(afterId: Int, id: Int!): ReorderProfileProjectsResponse
301
302# Reports a user.
303#
304# Arguments
305# id: Id of the user to report.
306# message: Additional message when reporting user.
307# reason: Reason for reporting the user.
308reportUser(
309id: Int!,
310message: ReportUserMessage,
311reason: ReportUserReasons!
312): ReportUserResponse
313
314requestFinalFreelancePayment(projectId: ID!): FreelancePayment
315
316# Activates automatic renewal of the users subscription to the specified creator
317resubscribeToCreator(creator_id: Int!): Subscription
318
319# Review freelance project
320reviewFreelanceProject(id: Int!, review: String!): FreelanceProjectReview
321
322# Mark up to 100 ids as seen
323#
324# Arguments
325# entities: The list of entities to be marked as seen
326# projectIds: Deprecated: use "entities" instead
327saveForYouFeedContentSeen(
328entities: [ForYouFeedSeenEntity!],
329projectIds: [Int!]
330): SaveForYouFeedContentSeen
331
332# Save a job on behalf of the authenticated user.
333#
334# Arguments
335# id: Job Id
336saveJob(id: Int!): SaveJobResponse
337
338# Create or edit a user's Hire Me settings
339saveUserAvailabilityInfo(
340availabilityTimeline: AvailabilityTimelineOption,
341buttonCTAType: AvailabilityButtonCTAType!,
342compensationMin: Float,
343currency: AvailabilityCurrencyType!,
344isAvailableFreelance: Boolean!,
345isAvailableFullTime: Boolean!,
346isLookingForRemote: Boolean!,
347isOpenToRelocation: Boolean!
348): UserAvailabilityInfo
349
350# Sends an analytics request
351sendAnalytic(
352analyticType: AnalyticType!,
353eventExtJson: String,
354eventFeatureName: String,
355eventHeight: Int!,
356eventMessage: String,
357eventPageName: String!,
358eventReferrer: String,
359eventUri: String!,
360eventWidth: Int!
361): SendAnalyticsResponse
362
363# Set the visibility of a user's NFT
364setNFTToBeHidden(moduleId: Int!): NFT
365
366# Set the visibility of a user's NFT
367setNFTToBeVisibile(moduleId: Int!): NFT
368
369# Hide a Stock asset on the user's profile
370setStockAssetToBeHidden(stockAssetId: String!): StockAssetProfileVisibility
371
372# Unhide a Stock asset on the user's profile
373setStockAssetToBeVisible(stockAssetId: String!): StockAssetProfileVisibility
374
375# Set a user's specified Single Use
376setUserFlag(flag: String!): UserFlag
377
378showNftsByWalletAddress(address: String!): User
379
380# Finalize a multipart upload for a source file > 10 MB
381sourceFileFinalizeMultiPartUpload(
382accessKey: String!,
383assetARN: String!,
384contentLength: Int!,
385contentMd5: String!,
386contentType: String!,
387path: String!,
388secretKey: String!,
389segments: [MultiPartSegment]!,
390sessionToken: String!,
391uploadId: String!
392): UploadedSourceFileDetails
393
394# Initialize a multipart upload for a source file > 10 MB
395#
396# Arguments
397# filePrefix: The prefix used for a new auto-generated unique
398# file name. `SOURCE_FILE` is used by default.
399sourceFileInitializeMultiPartUpload(
400contentLength: Int!,
401contentType: String!,
402filePrefix: FileUploadPrefix,
403path: String!
404): MultiPartUploadDetails
405
406# Request a direct upload url for a source file < 10 MB. Make a PUT request to the
407# returned URL with the following headers: "X-api-key: {api key}", "Authorization:
408# Bearer {user bearer token}", "Accept: application/vnd.adobe.file+json",
409# "Content-length: {content-length of the file uploaded}", "Content-type:
410# {content-type of the file uploaded}"
411#
412# Arguments
413# filePrefix: The prefix used for a new auto-generated unique
414# file name. `SOURCE_FILE` is used by default.
415sourceFileRequestDirectUploadUrl(
416fileName: String!,
417filePrefix: FileUploadPrefix
418): SourceFileDirectUploadUrl
419
420# Request a temporary download url for a source file
421sourceFileRequestDownloadUrl(sourceFileId: Int!): SourceFileDownloadUrl
422
423# Subscribes the logged in user to the specified creator
424subscribeToCreator(creator_id: Int!): Subscription
425
426# Subscribe to the web push notifications about a new content from the user
427# defined in the arguments on behalf of the authenticated user.
428#
429# Arguments
430# subscription: JSON encoded browser specific subscription object
431subscribeToWebPushNotifications(
432notificationType: NotificationType!,
433subscription: String,
434userId: Int,
435username: String
436): WebPush
437
438# Sets super signal relation between a user and a project. Deletes relation when
439# "remove" is true
440superSignal(projectId: Int!, remove: Boolean): Int
441
442# Transfer ownership of a project to the first co-owner
443transferProjectOwnership(id: Int!): Project
444
445# Unarchive up to 20 threads. A list of successfully unarchived thread ids is
446# returned.
447unarchiveInboxThreads(threadIds: [String!]!): [String]
448
449# Unfollows the specified gallery for the logged in user
450unfollowGallery(slug: String!): FollowGalleryResponse
451
452# Unfollows the specified gallery subcategory for the logged in user
453unfollowGallerySubcategory(
454parentSlug: String!,
455slug: String!
456): FollowSubcategoryResponse
457
458# Unfollows the specified tag for the logged in user
459unfollowTag(id: Int!): Int
460
461# Unfollows the specified team for the logged in user
462unfollowTeam(id: Int!): Team
463
464# Unfollows a user
465unfollowUser(id: Int!): FollowUserResponse
466
467# Unpins a project from the subscription overview.
468unpinSubscriptionProject(projectId: Int!): Project
469
470# Cancels all of the logged in users subscriptions and removes their saved card
471# info
472unsubscribeAndRemoveCard: StripePaymentMethod
473
474# Cancels the logged in users subscription to the specified creator at the end of
475# the billing cycle
476unsubscribeFromCreator(creator_id: Int!): Subscription
477
478# Unsubscribe from the web push notifications about a new context from the user
479# defined in the arguments on behalf of the authenticated user.
480unsubscribeFromWebPushNotifications(
481notificationType: NotificationType!,
482userId: Int,
483username: String
484): WebPush
485
486# Update the setting that determines if the logged-in user would like to receive
487# direct messages from all users or only followed users
488updateAllowsContactFromAnyoneSetting(
489value: Boolean!
490): AllowsContactFromAnyone
491
492# Updates a user's settings for allowing comment mentions from other users
493updateCommentMentionsSettings(
494setting: CommentMentionsSetting!
495): User
496
497# Update the specific job on behalf of the authenticated user.
498updateJob(id: Int!, params: UpdateJobParams!): UpdateJobResponse
499
500# update a user avatar image
501updateProfileAvatar(
502crop_x: Int!,
503crop_x2: Int!,
504crop_y: Int!,
505crop_y2: Int!,
506imageUrl: String!
507): Viewer
508
509# update a user banner image
510updateProfileBanner(
511bannerUrl: String!,
512height: Int!,
513width: Int!,
514x: Int!,
515y: Int!
516): Viewer
517
518# Update a users profile data
519updateProfileData(
520city: city_name,
521company: company,
522country: country_name,
523firstName: firstName,
524lastName: lastName,
525locationId: locationId,
526occupation: occupation,
527references: references,
528sections: sections,
529socialReferences: socialReferences,
530state: state_name,
531teams: teams,
532website: website
533): Viewer
534
535# === Not ready yet! ===
536#
537# Update the specific project on behalf of the authenticated user.
538updateProject(params: UpdateProjectParams!, projectId: Int!): UpdateProjectResponse
539
540# Update a Source File
541updateSourceFile(params: UpdateSourceFileParams!): SourceFile
542
543# Update the payment method used for subscriptions
544updateSubscriptionPaymentMethod(
545payment_method_id: String!
546): StripePaymentMethod
547
548}

link Required by

This element is not required by anyone