transfer_requests

Creates, updates, deletes, gets or lists a transfer_requests resource.

Overview

Name	transfer_requests
Type	Resource
Id	vercel.projects.transfer_requests

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	id_or_name	team_id, slug	Initiates a project transfer request from one team to another. <br /> Returns a code that remains valid for 24 hours and can be used to accept the transfer request by another team using the PUT /projects/transfer-request/:code endpoint. <br /> Users can also accept the project transfer request using the claim URL: https:​//vercel.com/claim-deployment?code=&lt;code&gt;&returnUrl=&lt;returnUrl&gt;. <br /> The code parameter specifies the project transfer request code generated using this endpoint. <br /> The returnUrl parameter redirects users to a specific page of the application if the claim URL is invalid or expired.
accept	exec	code	teamId, slug	Accept a project transfer request initated by another team. <br /> The code is generated using the POST /projects/:idOrName/transfer-request endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
code	string	The code of the project transfer request.
id_or_name	string	The ID or name of the project to transfer.
slug	string	The Team slug to perform the request on behalf of.
teamId	string	The Team identifier to perform the request on behalf of.
team_id	string	The Team identifier to perform the request on behalf of. (wire: teamId)

INSERT examples

create

Initiates a project transfer request from one team to another. <br /> Returns a code that remains valid for 24 hours and can be used to accept the transfer request by another team using the PUT /projects/transfer-request/:code endpoint. <br /> Users can also accept the project transfer request using the claim URL: https:​//vercel.com/claim-deployment?code=<code>&returnUrl=<returnUrl>. <br /> The code parameter specifies the project transfer request code generated using this endpoint. <br /> The returnUrl parameter redirects users to a specific page of the application if the claim URL is invalid or expired.

INSERT INTO vercel.projects.transfer_requests (
callback_url,
callback_secret,
id_or_name,
team_id,
slug
)
SELECT 
'{{ callback_url }}',
'{{ callback_secret }}',
'{{ id_or_name }}',
'{{ team_id }}',
'{{ slug }}'
RETURNING
code
;

Manifest

# Description fields are for documentation purposes
- name: transfer_requests
props:
  - name: id_or_name
    value: "{{ id_or_name }}"
    description: Required parameter for the transfer_requests resource.
  - name: callback_url
    value: "{{ callback_url }}"
    description: |
      The URL to send a webhook to when the transfer is accepted.
  - name: callback_secret
    value: "{{ callback_secret }}"
    description: |
      The secret to use to sign the webhook payload with HMAC-SHA256.
  - name: team_id
    value: "{{ team_id }}"
    description: The Team identifier to perform the request on behalf of.
    description: The Team identifier to perform the request on behalf of.
  - name: slug
    value: "{{ slug }}"
    description: The Team slug to perform the request on behalf of.
    description: The Team slug to perform the request on behalf of.

Lifecycle Methods

EXEC variables use wire (API) names.

accept

Accept a project transfer request initated by another team. <br /> The code is generated using the POST /projects/:idOrName/transfer-request endpoint.

EXEC vercel.projects.transfer_requests.accept 
@code='{{ code }}' --required, 
@teamId='{{ teamId }}', 
@slug='{{ slug }}' 
@@json=
'{
"newProjectName": "{{ newProjectName }}", 
"paidFeatures": "{{ paidFeatures }}", 
"acceptedPolicies": "{{ acceptedPolicies }}"
}'
;