Projects
Update a single project
Projects
Update a single project
PATCH
/
v1
/
projects
/
{projectId}
curl --request PATCH \
--url https://api.salesnip.com/v1/projects/{projectId} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"name": "Acme",
"description": "Acme",
"support": {
"method": "EMAIL",
"url": "https//example.com/support",
"email": "[email protected]"
},
"theme": {
"shapes": "ROUNDED",
"light": {
"overview": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"chat": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"primary": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"input": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"message": {
"user": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"bot": {
"background": "#4043ff",
"foreground": "#4043ff"
}
}
},
"dark": {
"overview": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"chat": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"primary": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"input": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"message": {
"user": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"bot": {
"background": "#4043ff",
"foreground": "#4043ff"
}
}
}
}
}'{
"success": true
}Authorizations
Path Parameters
The unique ID of the project.
Minimum length:
1Example:
"project_abcdefghjijklmnop"
Body
application/json
The name of the project.
Required string length:
3 - 25Example:
"Acme"
The name of the project.
Required string length:
3 - 25Example:
"Acme"
The support method to choose from.
Available options:
EMAIL, URL The URL to redirect to if the user requests to contact the support. This is required if you have support.method set to "URL".
Example:
"https//example.com/support"
The email address to redirect to if the user requests to contact the support. This is required if you have support.method set to "EMAIL".
Example:
The theme of the SaleSnip widget. This can be used to customize the colors of the widget to match your branding.
This field determines the overall shape style of UI components in the SaleSnip widget.
Available options:
ROUNDED, PILL, RECTANGULAR Example:
"ROUNDED"
The colors of the SaleSnip widget in light mode.
The colors of the SaleSnip widget in dark mode.
Response
200
application/json
Success
curl --request PATCH \
--url https://api.salesnip.com/v1/projects/{projectId} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"name": "Acme",
"description": "Acme",
"support": {
"method": "EMAIL",
"url": "https//example.com/support",
"email": "[email protected]"
},
"theme": {
"shapes": "ROUNDED",
"light": {
"overview": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"chat": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"primary": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"input": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"message": {
"user": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"bot": {
"background": "#4043ff",
"foreground": "#4043ff"
}
}
},
"dark": {
"overview": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"chat": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"primary": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"input": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"message": {
"user": {
"background": "#4043ff",
"foreground": "#4043ff"
},
"bot": {
"background": "#4043ff",
"foreground": "#4043ff"
}
}
}
}
}'{
"success": true
}