Project Settings

Get Project Settings

Retrieves the current settings for the specified project, including contact management options such as Unified Contact ID.

SecurityBasic or oAuth2
Request
path Parameters
project_id
required
string

The unique ID of the project. You can find this on the Sinch Dashboard.

Responses
200

A successful response.

Response Schema: application/json
project_id
string

The unique ID of the project.

object

The settings object containing contact settings.

400

Malformed request. See common error responses for more information.

401

Incorrect credentials. See common error responses for more information.

403

Correct credentials but you don't have access to the requested resource. See common error responses for more information.

500

Correct credentials but you don't have access to the requested resource. See common error responses for more information.

501

Something went wrong on our end, try again with exponential back-off. See common error responses for more information.

get/v1/projects/{project_id}/settings
Request samples
Response samples
application/json
{
  • "project_id": "{PROJECT_ID}",
  • "settings": {
    • "contact_settings": {
      }
    }
}

Create Project Settings

Creates initial settings for the project. Useful for enabling features like Unified Contact ID. For new projects with no existing contacts, you can enable Unified Contact ID immediately.

SecurityBasic or oAuth2
Request
path Parameters
project_id
required
string

The unique ID of the project. You can find this on the Sinch Dashboard.

Request Body schema: application/json
required

The project settings to create.

object (Contact Settings)

Settings related to contact management for the project.

unified_contact_id_enabled
boolean

Enables the Unified Contact ID feature. When enabled, contacts with the same phone number across SMS, RCS, and MMS channels are treated as a single entity. See the documentation for details and requirements.

Responses
200

A successful response.

Response Schema: application/json
project_id
string

The unique ID of the project.

object

The settings object containing contact settings.

400

Malformed request. See common error responses for more information.

401

Incorrect credentials. See common error responses for more information.

403

Correct credentials but you don't have access to the requested resource. See common error responses for more information.

500

Correct credentials but you don't have access to the requested resource. See common error responses for more information.

501

Something went wrong on our end, try again with exponential back-off. See common error responses for more information.

post/v1/projects/{project_id}/settings
Request samples
application/json
{
  • "contact_settings": {
    • "unified_contact_id_enabled": true
    }
}
Response samples
application/json
{
  • "project_id": "{PROJECT_ID}",
  • "settings": {
    • "contact_settings": {
      }
    }
}

Update Project Settings

Updates project settings (e.g. enabling/disabling Unified Contact ID). For existing projects, you must resolve all identity conflicts before enabling Unified Contact ID.

SecurityBasic or oAuth2
Request
path Parameters
project_id
required
string

The unique ID of the project. You can find this on the Sinch Dashboard.

Request Body schema: application/json
required

The project settings to update.

object (Contact Settings)

Settings related to contact management for the project.

unified_contact_id_enabled
boolean

Enables the Unified Contact ID feature. When enabled, contacts with the same phone number across SMS, RCS, and MMS channels are treated as a single entity. See the documentation for details and requirements.

Responses
200

A successful response.

Response Schema: application/json
project_id
string

The unique ID of the project.

object

The settings object containing contact settings.

400

Malformed request. See common error responses for more information.

401

Incorrect credentials. See common error responses for more information.

403

Correct credentials but you don't have access to the requested resource. See common error responses for more information.

500

Correct credentials but you don't have access to the requested resource. See common error responses for more information.

501

Something went wrong on our end, try again with exponential back-off. See common error responses for more information.

patch/v1/projects/{project_id}/settings
Request samples
application/json
{
  • "contact_settings": {
    • "unified_contact_id_enabled": true
    }
}
Response samples
application/json
{
  • "project_id": "{PROJECT_ID}",
  • "settings": {
    • "contact_settings": {
      }
    }
}

Delete Project Settings

Deletes all project-level settings for the specified project.

SecurityBasic or oAuth2
Request
path Parameters
project_id
required
string

The unique ID of the project. You can find this on the Sinch Dashboard.

Responses
200

A successful response.

400

Malformed request. See common error responses for more information.

401

Incorrect credentials. See common error responses for more information.

403

Correct credentials but you don't have access to the requested resource. See common error responses for more information.

500

Correct credentials but you don't have access to the requested resource. See common error responses for more information.

501

Something went wrong on our end, try again with exponential back-off. See common error responses for more information.

delete/v1/projects/{project_id}/settings
Request samples
Response samples
application/json
{
  • "code": 400,
  • "message": "Malformed request",
  • "status": "INVALID_REQUEST",
  • "details": [ ]
}