Create One favorite

Twenty SaaS

https://api.twenty.com/rest

POST

/favorites

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Successful operation

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.twenty.com/rest/favorites' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "position": 0,
    "forWorkspaceMemberId": "f7eace59-7486-4c52-9b13-e62a4a080bed",
    "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
    "favoriteFolderId": "1cffe046-196f-49c9-9965-7d97562b617c",
    "opportunityId": "3d9795f2-7722-4e1d-b41e-0c5d0c24a902",
    "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
    "workflowVersionId": "9697ac6f-bc45-42de-9ae8-625f0b5a8836",
    "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
    "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
    "noteId": "11bee8fe-2793-4911-9b27-a6f8473a2ccf",
    "viewId": "5aa272a5-73e4-4f9c-8123-4bac998fdb73"
}'

Response Example

201 - Example 1

{
    "data": {
        "createFavorite": {
            "position": 0,
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "deletedAt": "2019-08-24T14:15:22Z",
            "forWorkspaceMemberId": "f7eace59-7486-4c52-9b13-e62a4a080bed",
            "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
            "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
            "favoriteFolderId": "1cffe046-196f-49c9-9965-7d97562b617c",
            "opportunityId": "3d9795f2-7722-4e1d-b41e-0c5d0c24a902",
            "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
            "workflowVersionId": "9697ac6f-bc45-42de-9ae8-625f0b5a8836",
            "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
            "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
            "noteId": "11bee8fe-2793-4911-9b27-a6f8473a2ccf",
            "viewId": "5aa272a5-73e4-4f9c-8123-4bac998fdb73",
            "forWorkspaceMember": null,
            "person": null,
            "company": null,
            "favoriteFolder": null,
            "opportunity": null,
            "workflow": null,
            "workflowVersion": null,
            "workflowRun": null,
            "task": null,
            "note": null,
            "view": null
        }
    }
}

Modified at 2025-04-14 03:24:16

Find Many favorites

Create Many favorites